-
-
Save shaunpalmer/27ab2c75be74753227cb20e9cf03f383 to your computer and use it in GitHub Desktop.
Enables action and filter callbacks to be executed exactly once via the WordPress Plugin API. https://engineering.growella.com/one-time-callbacks-wordpress-plugin-api/
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
/** | |
* Registers the "One time hook" functionality. | |
* | |
* Note that this file is intentionally in the *global* namespace! | |
* | |
* @author Growella | |
* @license MIT | |
*/ | |
if ( ! function_exists( 'add_action_once' ) ) { | |
/** | |
* Register an action to run exactly one time. | |
* | |
* The arguments match that of add_action(), but this function will also register a second | |
* callback designed to remove the first immediately after it runs. | |
* | |
* @param string $hook The action name. | |
* @param callable $callback The callback function. | |
* @param int $priority Optional. The priority at which the callback should be executed. | |
* Default is 10. | |
* @param int $args Optional. The number of arguments expected by the callback function. | |
* Default is 1. | |
* @return bool Like add_action(), this function always returns true. | |
*/ | |
function add_action_once( $hook, $callback, $priority = 10, $args = 1 ) { | |
$singular = function () use ( $hook, $callback, $priority, $args, &$singular ) { | |
call_user_func_array( $callback, func_get_args() ); | |
remove_action( $hook, $singular, $priority, $args ); | |
}; | |
return add_action( $hook, $singular, $priority, $args ); | |
} | |
} | |
if ( ! function_exists( 'add_filter_once' ) ) { | |
/** | |
* Register a filter to run exactly one time. | |
* | |
* The arguments match that of add_filter(), but this function will also register a second | |
* callback designed to remove the first immediately after it runs. | |
* | |
* @param string $hook The filter name. | |
* @param callable $callback The callback function. | |
* @param int $priority Optional. The priority at which the callback should be executed. | |
* Default is 10. | |
* @param int $args Optional. The number of arguments expected by the callback function. | |
* Default is 1. | |
* @return bool Like add_filter(), this function always returns true. | |
*/ | |
function add_filter_once( $hook, $callback, $priority = 10, $args = 1 ) { | |
$singular = function () use ( $hook, $callback, $priority, $args, &$singular ) { | |
call_user_func_array( $callback, func_get_args() ); | |
remove_filter( $hook, $singular, $priority, $args ); | |
}; | |
return add_filter( $hook, $singular, $priority, $args ); | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
beneficial to manage custom post types and their behavior (such as registering actions/filters) on a per-post-type basis, possibly through a settings page for better control. Let's break this down a bit.
Settings Page:
Creating a settings page would allow more flexibility to control when and where these actions/filters run. A user could enable or disable certain behaviors (like one-time hooks) without touching code.
Dynamic Hook Control:
If each custom post type has unique hooks or behavior, controlling them one at a time based on settings could offer a more efficient, centralized way to manage hooks. For example, your settings page could toggle which post types need specific hooks, making management easier.
$enabled_post_types = get_option('enabled_post_types_for_hooks');
if (in_array($post_type, $enabled_post_types)) {
add_action_once( 'save_post', 'custom_save_post_handler', 10, 2 );
}