if ( ! isset( $wp_actions[ $tag ] ) ) {
return $wp_actions[ $tag ];
* Calls the callback functions that have been added to an action hook, specifying arguments in an array.
* @see do_action() This function is identical, but the arguments passed to the
* functions hooked to `$tag` are supplied using an array.
* @global WP_Hook[] $wp_filter Stores all of the filters and actions.
* @global int[] $wp_actions Stores the number of times each action was triggered.
* @global string[] $wp_current_filter Stores the list of current filters with the current one last.
* @param string $tag The name of the action to be executed.
* @param array $args The arguments supplied to the functions hooked to `$tag`.
function do_action_ref_array( $tag, $args ) {
global $wp_filter, $wp_actions, $wp_current_filter;
if ( ! isset( $wp_actions[ $tag ] ) ) {
// Do 'all' actions first.
if ( isset( $wp_filter['all'] ) ) {
$wp_current_filter[] = $tag;
$all_args = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
_wp_call_all_hook( $all_args );
if ( ! isset( $wp_filter[ $tag ] ) ) {
if ( isset( $wp_filter['all'] ) ) {
array_pop( $wp_current_filter );
if ( ! isset( $wp_filter['all'] ) ) {
$wp_current_filter[] = $tag;
$wp_filter[ $tag ]->do_action( $args );
array_pop( $wp_current_filter );
* Checks if any action has been registered for a hook.
* When using the `$function_to_check` argument, this function may return a non-boolean value
* that evaluates to false (e.g. 0), so use the `===` operator for testing the return value.
* @see has_filter() has_action() is an alias of has_filter().
* @param string $tag The name of the action hook.
* @param callable|false $function_to_check Optional. The callback to check for. Default false.
* @return bool|int If `$function_to_check` is omitted, returns boolean for whether the hook has
* anything registered. When checking a specific function, the priority of that
* hook is returned, or false if the function is not attached.
function has_action( $tag, $function_to_check = false ) {
return has_filter( $tag, $function_to_check );
* Removes a function from a specified action hook.
* This function removes a function attached to a specified action hook. This
* method can be used to remove default functions attached to a specific filter
* hook and possibly replace them with a substitute.
* @param string $tag The action hook to which the function to be removed is hooked.
* @param callable $function_to_remove The name of the function which should be removed.
* @param int $priority Optional. The priority of the function. Default 10.
* @return bool Whether the function is removed.
function remove_action( $tag, $function_to_remove, $priority = 10 ) {
return remove_filter( $tag, $function_to_remove, $priority );
* Remove all of the hooks from an action.
* @param string $tag The action to remove hooks from.
* @param int|false $priority The priority number to remove them from. Default false.
* @return true True when finished.
function remove_all_actions( $tag, $priority = false ) {
return remove_all_filters( $tag, $priority );
* Fires functions attached to a deprecated filter hook.
* When a filter hook is deprecated, the apply_filters() call is replaced with
* apply_filters_deprecated(), which triggers a deprecation notice and then fires
* the original filter hook.
* Note: the value and extra arguments passed to the original apply_filters() call
* must be passed here to `$args` as an array. For example:
* return apply_filters( 'wpdocs_filter', $value, $extra_arg );
* return apply_filters_deprecated( 'wpdocs_filter', array( $value, $extra_arg ), '4.9.0', 'wpdocs_new_filter' );
* @see _deprecated_hook()
* @param string $tag The name of the filter hook.
* @param array $args Array of additional function arguments to be passed to apply_filters().
* @param string $version The version of WordPress that deprecated the hook.
* @param string $replacement Optional. The hook that should have been used. Default empty.
* @param string $message Optional. A message regarding the change. Default empty.
function apply_filters_deprecated( $tag, $args, $version, $replacement = '', $message = '' ) {
if ( ! has_filter( $tag ) ) {
_deprecated_hook( $tag, $version, $replacement, $message );
return apply_filters_ref_array( $tag, $args );
* Fires functions attached to a deprecated action hook.
* When an action hook is deprecated, the do_action() call is replaced with
* do_action_deprecated(), which triggers a deprecation notice and then fires
* @see _deprecated_hook()
* @param string $tag The name of the action hook.
* @param array $args Array of additional function arguments to be passed to do_action().
* @param string $version The version of WordPress that deprecated the hook.
* @param string $replacement Optional. The hook that should have been used. Default empty.
* @param string $message Optional. A message regarding the change. Default empty.
function do_action_deprecated( $tag, $args, $version, $replacement = '', $message = '' ) {
if ( ! has_action( $tag ) ) {
_deprecated_hook( $tag, $version, $replacement, $message );
do_action_ref_array( $tag, $args );
// Functions for handling plugins.
* Gets the basename of a plugin.
* This method extracts the name of a plugin from its filename.
* @global array $wp_plugin_paths
* @param string $file The filename of plugin.
* @return string The name of a plugin.
function plugin_basename( $file ) {
// $wp_plugin_paths contains normalized paths.
$file = wp_normalize_path( $file );
arsort( $wp_plugin_paths );
foreach ( $wp_plugin_paths as $dir => $realdir ) {
if ( strpos( $file, $realdir ) === 0 ) {
$file = $dir . substr( $file, strlen( $realdir ) );
$plugin_dir = wp_normalize_path( WP_PLUGIN_DIR );
$mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR );
// Get relative path from plugins directory.
$file = preg_replace( '#^' . preg_quote( $plugin_dir, '#' ) . '/|^' . preg_quote( $mu_plugin_dir, '#' ) . '/#', '', $file );
$file = trim( $file, '/' );
* Register a plugin's real path.
* This is used in plugin_basename() to resolve symlinked paths.
* @see wp_normalize_path()
* @global array $wp_plugin_paths
* @param string $file Known path to the file.
* @return bool Whether the path was able to be registered.
function wp_register_plugin_realpath( $file ) {
// Normalize, but store as static to avoid recalculation of a constant value.
static $wp_plugin_path = null, $wpmu_plugin_path = null;
if ( ! isset( $wp_plugin_path ) ) {
$wp_plugin_path = wp_normalize_path( WP_PLUGIN_DIR );
$wpmu_plugin_path = wp_normalize_path( WPMU_PLUGIN_DIR );
$plugin_path = wp_normalize_path( dirname( $file ) );
$plugin_realpath = wp_normalize_path( dirname( realpath( $file ) ) );
if ( $plugin_path === $wp_plugin_path || $plugin_path === $wpmu_plugin_path ) {
if ( $plugin_path !== $plugin_realpath ) {
$wp_plugin_paths[ $plugin_path ] = $plugin_realpath;
* Get the filesystem directory path (with trailing slash) for the plugin __FILE__ passed in.
* @param string $file The filename of the plugin (__FILE__).
* @return string the filesystem path of the directory that contains the plugin.
function plugin_dir_path( $file ) {
return trailingslashit( dirname( $file ) );
* Get the URL directory path (with trailing slash) for the plugin __FILE__ passed in.
* @param string $file The filename of the plugin (__FILE__).
* @return string the URL path of the directory that contains the plugin.
function plugin_dir_url( $file ) {
return trailingslashit( plugins_url( '', $file ) );
* Set the activation hook for a plugin.
* When a plugin is activated, the action 'activate_PLUGINNAME' hook is
* called. In the name of this hook, PLUGINNAME is replaced with the name
* of the plugin, including the optional subdirectory. For example, when the
* plugin is located in wp-content/plugins/sampleplugin/sample.php, then
* the name of this hook will become 'activate_sampleplugin/sample.php'.
* When the plugin consists of only one file and is (as by default) located at
* wp-content/plugins/sample.php the name of this hook will be
* @param string $file The filename of the plugin including the path.
* @param callable $function The function hooked to the 'activate_PLUGIN' action.
function register_activation_hook( $file, $function ) {
$file = plugin_basename( $file );
add_action( 'activate_' . $file, $function );
* Set the deactivation hook for a plugin.
* When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is
* called. In the name of this hook, PLUGINNAME is replaced with the name
* of the plugin, including the optional subdirectory. For example, when the
* plugin is located in wp-content/plugins/sampleplugin/sample.php, then
* the name of this hook will become 'deactivate_sampleplugin/sample.php'.
* When the plugin consists of only one file and is (as by default) located at
* wp-content/plugins/sample.php the name of this hook will be
* 'deactivate_sample.php'.
* @param string $file The filename of the plugin including the path.
* @param callable $function The function hooked to the 'deactivate_PLUGIN' action.
function register_deactivation_hook( $file, $function ) {
$file = plugin_basename( $file );
add_action( 'deactivate_' . $file, $function );
* Set the uninstallation hook for a plugin.
* Registers the uninstall hook that will be called when the user clicks on the
* uninstall link that calls for the plugin to uninstall itself. The link won't
* be active unless the plugin hooks into the action.
* The plugin should not run arbitrary code outside of functions, when
* registering the uninstall hook. In order to run using the hook, the plugin
* will have to be included, which means that any code laying outside of a
* function will be run during the uninstallation process. The plugin should not
* hinder the uninstallation process.
* If the plugin can not be written without running code within the plugin, then
* the plugin should create a file named 'uninstall.php' in the base plugin
* folder. This file will be called, if it exists, during the uninstallation process
* bypassing the uninstall hook. The plugin, when using the 'uninstall.php'
* should always check for the 'WP_UNINSTALL_PLUGIN' constant, before
* @param string $file Plugin file.
* @param callable $callback The callback to run when the hook is called. Must be
* a static method or function.
function register_uninstall_hook( $file, $callback ) {
if ( is_array( $callback ) && is_object( $callback[0] ) ) {
_doing_it_wrong( __FUNCTION__, __( 'Only a static class method or function can be used in an uninstall hook.' ), '3.1.0' );
* The option should not be autoloaded, because it is not needed in most
* cases. Emphasis should be put on using the 'uninstall.php' way of
* uninstalling the plugin.
$uninstallable_plugins = (array) get_option( 'uninstall_plugins' );
$plugin_basename = plugin_basename( $file );
if ( ! isset( $uninstallable_plugins[ $plugin_basename ] ) || $uninstallable_plugins[ $plugin_basename ] !== $callback ) {
$uninstallable_plugins[ $plugin_basename ] = $callback;
update_option( 'uninstall_plugins', $uninstallable_plugins );
* Call the 'all' hook, which will process the functions hooked into it.
* The 'all' hook passes all of the arguments or parameters that were used for
* the hook, which this function was called for.
* This function is used internally for apply_filters(), do_action(), and
* do_action_ref_array() and is not meant to be used from outside those
* functions. This function does not check for the existence of the all hook, so
* it will fail unless the all hook exists prior to this function call.
* @global WP_Hook[] $wp_filter Stores all of the filters and actions.
* @param array $args The collected parameters from the hook that was called.
function _wp_call_all_hook( $args ) {
$wp_filter['all']->do_all_hook( $args );
* Build Unique ID for storage and retrieval.
* The old way to serialize the callback caused issues and this function is the
* solution. It works by checking for objects and creating a new property in
* the class to keep track of the object and new objects of the same class that
* It also allows for the removal of actions and filters for objects after they
* change class properties. It is possible to include the property $wp_filter_id
* in your class and set it to "null" or a number to bypass the workaround.
* However this will prevent you from adding new classes and any new classes
* will overwrite the previous hook by the same class.
* Functions and static method callbacks are just returned as strings and
* shouldn't have any speed penalty.
* @link https://core.trac.wordpress.org/ticket/3875
* @since 5.3.0 Removed workarounds for spl_object_hash().
* `$tag` and `$priority` are no longer used,
* and the function always returns a string.
* @param string $tag Unused. The name of the filter to build ID for.
* @param callable $function The function to generate ID for.
* @param int $priority Unused. The order in which the functions
* associated with a particular action are executed.
* @return string Unique function ID for usage as array key.
function _wp_filter_build_unique_id( $tag, $function, $priority ) {
if ( is_string( $function ) ) {
if ( is_object( $function ) ) {
// Closures are currently implemented as objects.
$function = array( $function, '' );
$function = (array) $function;
if ( is_object( $function[0] ) ) {
return spl_object_hash( $function[0] ) . $function[1];
} elseif ( is_string( $function[0] ) ) {
return $function[0] . '::' . $function[1];