X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..16e7b37c7914d753890c1a05a9335f3b43751eb8:/wp-includes/plugin.php
diff --git a/wp-includes/plugin.php b/wp-includes/plugin.php
index d616a2a9..86f1c3b3 100644
--- a/wp-includes/plugin.php
+++ b/wp-includes/plugin.php
@@ -8,29 +8,34 @@
* To hook methods, you'll need to pass an array one of two ways.
*
* Any of the syntaxes explained in the PHP documentation for the
- * {@link http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'}
+ * {@link https://secure.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'}
* type are valid.
*
- * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for
+ * Also see the {@link https://codex.wordpress.org/Plugin_API Plugin API} for
* more information and examples on how to use a lot of these functions.
*
+ * This file should have no external dependencies.
+ *
* @package WordPress
* @subpackage Plugin
* @since 1.5.0
*/
// Initialize the filter globals.
-global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
+require( dirname( __FILE__ ) . '/class-wp-hook.php' );
+
+/** @var WP_Hook[] $wp_filter */
+global $wp_filter, $wp_actions, $wp_current_filter;
-if ( ! isset( $wp_filter ) )
+if ( $wp_filter ) {
+ $wp_filter = WP_Hook::build_preinitialized_hooks( $wp_filter );
+} else {
$wp_filter = array();
+}
if ( ! isset( $wp_actions ) )
$wp_actions = array();
-if ( ! isset( $merged_filters ) )
- $merged_filters = array();
-
if ( ! isset( $wp_current_filter ) )
$wp_current_filter = array();
@@ -45,46 +50,65 @@ if ( ! isset( $wp_current_filter ) )
* the opportunity to modify a value by returning a new value.
*
* The following example shows how a callback function is bound to a filter hook.
- * Note that $example is passed to the callback, (maybe) modified, then returned:
*
- *
- * function example_callback( $example ) {
- * // Maybe modify $example in some way
- * return $example;
- * }
- * add_filter( 'example_filter', 'example_callback' );
- *
+ * Note that `$example` is passed to the callback, (maybe) modified, then returned:
+ *
+ * function example_callback( $example ) {
+ * // Maybe modify $example in some way.
+ * return $example;
+ * }
+ * add_filter( 'example_filter', 'example_callback' );
+ *
+ * Bound callbacks can accept from none to the total number of arguments passed as parameters
+ * in the corresponding apply_filters() call.
+ *
+ * In other words, if an apply_filters() call passes four total arguments, callbacks bound to
+ * it can accept none (the same as 1) of the arguments or up to four. The important part is that
+ * the `$accepted_args` value must reflect the number of arguments the bound callback *actually*
+ * opted to accept. If no arguments were accepted by the callback that is considered to be the
+ * same as accepting 1 argument. For example:
*
- * Since WordPress 1.5.1, bound callbacks can take as many arguments as are
- * passed as parameters in the corresponding apply_filters() call. The $accepted_args
- * parameter allows for calling functions only when the number of args match.
+ * // Filter call.
+ * $value = apply_filters( 'hook', $value, $arg2, $arg3 );
*
- * Note: the function will return true whether or not the callback
- * is valid. It is up to you to take care. This is done for optimization purposes,
- * so everything is as quick as possible.
+ * // Accepting zero/one arguments.
+ * function example_callback() {
+ * ...
+ * return 'some value';
+ * }
+ * add_filter( 'hook', 'example_callback' ); // Where $priority is default 10, $accepted_args is default 1.
+ *
+ * // Accepting two arguments (three possible).
+ * function example_callback( $value, $arg2 ) {
+ * ...
+ * return $maybe_modified_value;
+ * }
+ * add_filter( 'hook', 'example_callback', 10, 2 ); // Where $priority is 10, $accepted_args is 2.
+ *
+ * *Note:* The function will return true whether or not the callback is valid.
+ * It is up to you to take care. This is done for optimization purposes, so
+ * everything is as quick as possible.
*
* @since 0.71
*
* @global array $wp_filter A multidimensional array of all hooks and the callbacks hooked to them.
- * @global array $merged_filters Tracks the tags that need to be merged for later. If the hook is added,
- * it doesn't need to run through that process.
*
* @param string $tag The name of the filter to hook the $function_to_add callback to.
- * @param callback $function_to_add The callback to be run when the filter is applied.
+ * @param callable $function_to_add The callback to be run when the filter is applied.
* @param int $priority Optional. Used to specify the order in which the functions
* associated with a particular action are executed. Default 10.
* Lower numbers correspond with earlier execution,
* and functions with the same priority are executed
* in the order in which they were added to the action.
* @param int $accepted_args Optional. The number of arguments the function accepts. Default 1.
- * @return boolean true
+ * @return true
*/
function add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1 ) {
- global $wp_filter, $merged_filters;
-
- $idx = _wp_filter_build_unique_id($tag, $function_to_add, $priority);
- $wp_filter[$tag][$priority][$idx] = array('function' => $function_to_add, 'accepted_args' => $accepted_args);
- unset( $merged_filters[ $tag ] );
+ global $wp_filter;
+ if ( ! isset( $wp_filter[ $tag ] ) ) {
+ $wp_filter[ $tag ] = new WP_Hook();
+ }
+ $wp_filter[ $tag ]->add_filter( $tag, $function_to_add, $priority, $accepted_args );
return true;
}
@@ -96,47 +120,22 @@ function add_filter( $tag, $function_to_add, $priority = 10, $accepted_args = 1
* @global array $wp_filter Stores all of the filters.
*
* @param string $tag The name of the filter hook.
- * @param callback|bool $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. 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.
+ * @param callable|bool $function_to_check Optional. The callback to check for. Default false.
+ * @return false|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. 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.
*/
function has_filter($tag, $function_to_check = false) {
- // Don't reset the internal array pointer
- $wp_filter = $GLOBALS['wp_filter'];
-
- $has = ! empty( $wp_filter[ $tag ] );
-
- // Make sure at least one priority has a filter callback
- if ( $has ) {
- $exists = false;
- foreach ( $wp_filter[ $tag ] as $callbacks ) {
- if ( ! empty( $callbacks ) ) {
- $exists = true;
- break;
- }
- }
-
- if ( ! $exists ) {
- $has = false;
- }
- }
-
- if ( false === $function_to_check || false == $has )
- return $has;
+ global $wp_filter;
- if ( !$idx = _wp_filter_build_unique_id($tag, $function_to_check, false) )
+ if ( ! isset( $wp_filter[ $tag ] ) ) {
return false;
-
- foreach ( (array) array_keys($wp_filter[$tag]) as $priority ) {
- if ( isset($wp_filter[$tag][$priority][$idx]) )
- return $priority;
}
- return false;
+ return $wp_filter[ $tag ]->has_filter( $tag, $function_to_check );
}
/**
@@ -148,35 +147,34 @@ function has_filter($tag, $function_to_check = false) {
* the $tag parameter.
*
* The function allows for additional arguments to be added and passed to hooks.
- *
- * // Our filter callback function
- * function example_callback( $string, $arg1, $arg2 ) {
- * // (maybe) modify $string
- * return $string;
- * }
- * add_filter( 'example_filter', 'example_callback', 10, 3 );
- *
- * // Apply the filters by calling the 'example_callback' function we
- * // "hooked" to 'example_filter' using the add_filter() function above.
- * // - 'example_filter' is the filter hook $tag
- * // - 'filter me' is the value being filtered
- * // - $arg1 and $arg2 are the additional arguments passed to the callback.
- * $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
- *
+ *
+ * // Our filter callback function
+ * function example_callback( $string, $arg1, $arg2 ) {
+ * // (maybe) modify $string
+ * return $string;
+ * }
+ * add_filter( 'example_filter', 'example_callback', 10, 3 );
+ *
+ * /*
+ * * Apply the filters by calling the 'example_callback' function we
+ * * "hooked" to 'example_filter' using the add_filter() function above.
+ * * - 'example_filter' is the filter hook $tag
+ * * - 'filter me' is the value being filtered
+ * * - $arg1 and $arg2 are the additional arguments passed to the callback.
+ * $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
*
* @since 0.71
*
* @global array $wp_filter Stores all of the filters.
- * @global array $merged_filters Merges the filter hooks using this function.
* @global array $wp_current_filter Stores the list of current filters with the current one last.
*
- * @param string $tag The name of the filter hook.
- * @param mixed $value The value on which the filters hooked to $tag are applied on.
- * @param mixed $var Additional variables passed to the functions hooked to $tag.
+ * @param string $tag The name of the filter hook.
+ * @param mixed $value The value on which the filters hooked to `$tag` are applied on.
+ * @param mixed $var,... Additional variables passed to the functions hooked to `$tag`.
* @return mixed The filtered value after all hooked functions are applied to it.
*/
function apply_filters( $tag, $value ) {
- global $wp_filter, $merged_filters, $wp_current_filter;
+ global $wp_filter, $wp_current_filter;
$args = array();
@@ -196,41 +194,28 @@ function apply_filters( $tag, $value ) {
if ( !isset($wp_filter['all']) )
$wp_current_filter[] = $tag;
- // Sort.
- if ( !isset( $merged_filters[ $tag ] ) ) {
- ksort($wp_filter[$tag]);
- $merged_filters[ $tag ] = true;
- }
-
- reset( $wp_filter[ $tag ] );
-
if ( empty($args) )
$args = func_get_args();
- do {
- foreach( (array) current($wp_filter[$tag]) as $the_ )
- if ( !is_null($the_['function']) ){
- $args[1] = $value;
- $value = call_user_func_array($the_['function'], array_slice($args, 1, (int) $the_['accepted_args']));
- }
+ // don't pass the tag name to WP_Hook
+ array_shift( $args );
- } while ( next($wp_filter[$tag]) !== false );
+ $filtered = $wp_filter[ $tag ]->apply_filters( $value, $args );
array_pop( $wp_current_filter );
- return $value;
+ return $filtered;
}
/**
* Execute functions hooked on a specific filter hook, specifying arguments in an array.
*
- * @see apply_filters() This function is identical, but the arguments passed to the
- * functions hooked to $tag are supplied using an array.
- *
* @since 3.0.0
*
+ * @see apply_filters() This function is identical, but the arguments passed to the
+ * functions hooked to `$tag` are supplied using an array.
+ *
* @global array $wp_filter Stores all of the filters
- * @global array $merged_filters Merges the filter hooks using this function.
* @global array $wp_current_filter Stores the list of current filters with the current one last
*
* @param string $tag The name of the filter hook.
@@ -238,7 +223,7 @@ function apply_filters( $tag, $value ) {
* @return mixed The filtered value after all hooked functions are applied to it.
*/
function apply_filters_ref_array($tag, $args) {
- global $wp_filter, $merged_filters, $wp_current_filter;
+ global $wp_filter, $wp_current_filter;
// Do 'all' actions first
if ( isset($wp_filter['all']) ) {
@@ -256,24 +241,11 @@ function apply_filters_ref_array($tag, $args) {
if ( !isset($wp_filter['all']) )
$wp_current_filter[] = $tag;
- // Sort
- if ( !isset( $merged_filters[ $tag ] ) ) {
- ksort($wp_filter[$tag]);
- $merged_filters[ $tag ] = true;
- }
-
- reset( $wp_filter[ $tag ] );
-
- do {
- foreach( (array) current($wp_filter[$tag]) as $the_ )
- if ( !is_null($the_['function']) )
- $args[0] = call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));
-
- } while ( next($wp_filter[$tag]) !== false );
+ $filtered = $wp_filter[ $tag ]->apply_filters( $args[0], $args );
array_pop( $wp_current_filter );
- return $args[0];
+ return $filtered;
}
/**
@@ -289,25 +261,22 @@ function apply_filters_ref_array($tag, $args) {
*
* @since 1.2.0
*
+ * @global array $wp_filter Stores all of the filters
+ *
* @param string $tag The filter hook to which the function to be removed is hooked.
- * @param callback $function_to_remove The name of the function which should be removed.
+ * @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 boolean Whether the function existed before it was removed.
+ * @return bool Whether the function existed before it was removed.
*/
function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
- $function_to_remove = _wp_filter_build_unique_id( $tag, $function_to_remove, $priority );
-
- $r = isset( $GLOBALS['wp_filter'][ $tag ][ $priority ][ $function_to_remove ] );
+ global $wp_filter;
- if ( true === $r ) {
- unset( $GLOBALS['wp_filter'][ $tag ][ $priority ][ $function_to_remove ] );
- if ( empty( $GLOBALS['wp_filter'][ $tag ][ $priority ] ) ) {
- unset( $GLOBALS['wp_filter'][ $tag ][ $priority ] );
+ $r = false;
+ if ( isset( $wp_filter[ $tag ] ) ) {
+ $r = $wp_filter[ $tag ]->remove_filter( $tag, $function_to_remove, $priority );
+ if ( ! $wp_filter[ $tag ]->callbacks ) {
+ unset( $wp_filter[ $tag ] );
}
- if ( empty( $GLOBALS['wp_filter'][ $tag ] ) ) {
- $GLOBALS['wp_filter'][ $tag ] = array();
- }
- unset( $GLOBALS['merged_filters'][ $tag ] );
}
return $r;
@@ -318,25 +287,22 @@ function remove_filter( $tag, $function_to_remove, $priority = 10 ) {
*
* @since 2.7.0
*
+ * @global array $wp_filter Stores all of the filters
+ *
* @param string $tag The filter to remove hooks from.
* @param int|bool $priority Optional. The priority number to remove. Default false.
- * @return bool True when finished.
+ * @return true True when finished.
*/
function remove_all_filters( $tag, $priority = false ) {
- global $wp_filter, $merged_filters;
+ global $wp_filter;
if ( isset( $wp_filter[ $tag ]) ) {
- if ( false !== $priority && isset( $wp_filter[ $tag ][ $priority ] ) ) {
- $wp_filter[ $tag ][ $priority ] = array();
- } else {
- $wp_filter[ $tag ] = array();
+ $wp_filter[ $tag ]->remove_all_filters( $priority );
+ if ( ! $wp_filter[ $tag ]->has_filters() ) {
+ unset( $wp_filter[ $tag ] );
}
}
- if ( isset( $merged_filters[ $tag ] ) ) {
- unset( $merged_filters[ $tag ] );
- }
-
return true;
}
@@ -345,6 +311,8 @@ function remove_all_filters( $tag, $priority = false ) {
*
* @since 2.5.0
*
+ * @global array $wp_current_filter Stores the list of current filters with the current one last
+ *
* @return string Hook name of the current filter or action.
*/
function current_filter() {
@@ -357,8 +325,6 @@ function current_filter() {
*
* @since 3.9.0
*
- * @uses current_filter()
- *
* @return string Hook name of the current action.
*/
function current_action() {
@@ -401,8 +367,6 @@ function doing_filter( $filter = null ) {
*
* @since 3.9.0
*
- * @uses doing_filter()
- *
* @param string|null $action Optional. Action to check. Defaults to null, which checks
* if any action is currently being run.
* @return bool Whether the action is currently in the stack.
@@ -421,17 +385,15 @@ function doing_action( $action = null ) {
*
* @since 1.2.0
*
- * @uses add_filter() Adds an action. Parameter list and functionality are the same.
- *
* @param string $tag The name of the action to which the $function_to_add is hooked.
- * @param callback $function_to_add The name of the function you wish to be called.
+ * @param callable $function_to_add The name of the function you wish to be called.
* @param int $priority Optional. Used to specify the order in which the functions
* associated with a particular action are executed. Default 10.
* Lower numbers correspond with earlier execution,
* and functions with the same priority are executed
* in the order in which they were added to the action.
- * @param int $accepted_args Optional. The number of arguments the function accept. Default 1.
- * @return bool Will always return true.
+ * @param int $accepted_args Optional. The number of arguments the function accepts. Default 1.
+ * @return true Will always return true.
*/
function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
return add_filter($tag, $function_to_add, $priority, $accepted_args);
@@ -440,27 +402,24 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
/**
* Execute functions hooked on a specific action hook.
*
- * This function invokes all functions attached to action hook $tag. It is
+ * This function invokes all functions attached to action hook `$tag`. It is
* possible to create new action hooks by simply calling this function,
- * specifying the name of the new hook using the $tag parameter.
+ * specifying the name of the new hook using the `$tag` parameter.
*
- * You can pass extra arguments to the hooks, much like you can with
- * apply_filters().
+ * You can pass extra arguments to the hooks, much like you can with apply_filters().
*
* @since 1.2.0
*
- * @see apply_filters() This function works similar with the exception that nothing
- * is returned and only the functions or methods are called.
- * @global array $wp_filter Stores all of the filters
- * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global array $wp_filter Stores all of the filters
+ * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global array $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 mixed $arg Optional. Additional arguments which are passed on to the
- * functions hooked to the action. Default empty.
- * @return null Will return null if $tag does not exist in $wp_filter array.
+ * @param string $tag The name of the action to be executed.
+ * @param mixed $arg,... Optional. Additional arguments which are passed on to the
+ * functions hooked to the action. Default empty.
*/
function do_action($tag, $arg = '') {
- global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
+ global $wp_filter, $wp_actions, $wp_current_filter;
if ( ! isset($wp_actions[$tag]) )
$wp_actions[$tag] = 1;
@@ -488,23 +447,10 @@ function do_action($tag, $arg = '') {
$args[] =& $arg[0];
else
$args[] = $arg;
- for ( $a = 2; $a < func_num_args(); $a++ )
+ for ( $a = 2, $num = func_num_args(); $a < $num; $a++ )
$args[] = func_get_arg($a);
- // Sort
- if ( !isset( $merged_filters[ $tag ] ) ) {
- ksort($wp_filter[$tag]);
- $merged_filters[ $tag ] = true;
- }
-
- reset( $wp_filter[ $tag ] );
-
- do {
- foreach ( (array) current($wp_filter[$tag]) as $the_ )
- if ( !is_null($the_['function']) )
- call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));
-
- } while ( next($wp_filter[$tag]) !== false );
+ $wp_filter[ $tag ]->do_action( $args );
array_pop($wp_current_filter);
}
@@ -535,15 +481,15 @@ function did_action($tag) {
*
* @see do_action() This function is identical, but the arguments passed to the
* functions hooked to $tag< are supplied using an array.
- * @global array $wp_filter Stores all of the filters
- * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global array $wp_filter Stores all of the filters
+ * @global array $wp_actions Increments the amount of times action was triggered.
+ * @global array $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
- * @return null Will return null if $tag does not exist in $wp_filter array
+ * @param array $args The arguments supplied to the functions hooked to `$tag`.
*/
function do_action_ref_array($tag, $args) {
- global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
+ global $wp_filter, $wp_actions, $wp_current_filter;
if ( ! isset($wp_actions[$tag]) )
$wp_actions[$tag] = 1;
@@ -566,20 +512,7 @@ function do_action_ref_array($tag, $args) {
if ( !isset($wp_filter['all']) )
$wp_current_filter[] = $tag;
- // Sort
- if ( !isset( $merged_filters[ $tag ] ) ) {
- ksort($wp_filter[$tag]);
- $merged_filters[ $tag ] = true;
- }
-
- reset( $wp_filter[ $tag ] );
-
- do {
- foreach( (array) current($wp_filter[$tag]) as $the_ )
- if ( !is_null($the_['function']) )
- call_user_func_array($the_['function'], array_slice($args, 0, (int) $the_['accepted_args']));
-
- } while ( next($wp_filter[$tag]) !== false );
+ $wp_filter[ $tag ]->do_action( $args );
array_pop($wp_current_filter);
}
@@ -592,7 +525,7 @@ function do_action_ref_array($tag, $args) {
* @see has_filter() has_action() is an alias of has_filter().
*
* @param string $tag The name of the action hook.
- * @param callback|bool $function_to_check Optional. The callback to check for. Default false.
+ * @param callable|bool $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. When using the
@@ -614,9 +547,9 @@ function has_action($tag, $function_to_check = false) {
* @since 1.2.0
*
* @param string $tag The action hook to which the function to be removed is hooked.
- * @param callback $function_to_remove The name of the function which should be removed.
+ * @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 boolean Whether the function is removed.
+ * @return bool Whether the function is removed.
*/
function remove_action( $tag, $function_to_remove, $priority = 10 ) {
return remove_filter( $tag, $function_to_remove, $priority );
@@ -629,12 +562,66 @@ function remove_action( $tag, $function_to_remove, $priority = 10 ) {
*
* @param string $tag The action to remove hooks from.
* @param int|bool $priority The priority number to remove them from. Default false.
- * @return bool True when finished.
+ * @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.
+ *
+ * @since 4.6.0
+ *
+ * @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 false.
+ * @param string $message Optional. A message regarding the change. Default null.
+ */
+function apply_filters_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
+ if ( ! has_filter( $tag ) ) {
+ return $args[0];
+ }
+
+ _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
+ * the original hook.
+ *
+ * @since 4.6.0
+ *
+ * @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.
+ * @param string $message Optional. A message regarding the change.
+ */
+function do_action_deprecated( $tag, $args, $version, $replacement = false, $message = null ) {
+ if ( ! has_action( $tag ) ) {
+ return;
+ }
+
+ _deprecated_hook( $tag, $version, $replacement, $message );
+
+ do_action_ref_array( $tag, $args );
+}
+
//
// Functions for handling plugins.
//
@@ -646,7 +633,7 @@ function remove_all_actions($tag, $priority = false) {
*
* @since 1.5.0
*
- * @uses WP_PLUGIN_DIR, WPMU_PLUGIN_DIR
+ * @global array $wp_plugin_paths
*
* @param string $file The filename of plugin.
* @return string The name of a plugin.
@@ -654,13 +641,16 @@ function remove_all_actions($tag, $priority = false) {
function plugin_basename( $file ) {
global $wp_plugin_paths;
+ // $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 ) );
}
}
- $file = wp_normalize_path( $file );
$plugin_dir = wp_normalize_path( WP_PLUGIN_DIR );
$mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR );
@@ -676,7 +666,12 @@ function plugin_basename( $file ) {
*
* @since 3.9.0
*
- * @see plugin_basename()
+ * @see wp_normalize_path()
+ *
+ * @global array $wp_plugin_paths
+ *
+ * @staticvar string $wp_plugin_path
+ * @staticvar string $wpmu_plugin_path
*
* @param string $file Known path to the file.
* @return bool Whether the path was able to be registered.
@@ -685,7 +680,7 @@ function wp_register_plugin_realpath( $file ) {
global $wp_plugin_paths;
// Normalize, but store as static to avoid recalculation of a constant value
- static $wp_plugin_path, $wpmu_plugin_path;
+ 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 );
@@ -745,7 +740,7 @@ function plugin_dir_url( $file ) {
* @since 2.0.0
*
* @param string $file The filename of the plugin including the path.
- * @param callback $function The function hooked to the 'activate_PLUGIN' action.
+ * @param callable $function The function hooked to the 'activate_PLUGIN' action.
*/
function register_activation_hook($file, $function) {
$file = plugin_basename($file);
@@ -768,7 +763,7 @@ function register_activation_hook($file, $function) {
* @since 2.0.0
*
* @param string $file The filename of the plugin including the path.
- * @param callback $function The function hooked to the 'deactivate_PLUGIN' action.
+ * @param callable $function The function hooked to the 'deactivate_PLUGIN' action.
*/
function register_deactivation_hook($file, $function) {
$file = plugin_basename($file);
@@ -798,12 +793,12 @@ function register_deactivation_hook($file, $function) {
* @since 2.7.0
*
* @param string $file Plugin file.
- * @param callback $callback The callback to run when the hook is called. Must be
+ * @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' );
+ _doing_it_wrong( __FUNCTION__, __( 'Only a static class method or function can be used in an uninstall hook.' ), '3.1.0' );
return;
}
@@ -832,27 +827,21 @@ function register_uninstall_hook( $file, $callback ) {
* @since 2.5.0
* @access private
*
- * @uses $wp_filter Used to process all of the functions in the 'all' hook.
+ * @global array $wp_filter Stores all of the filters
*
* @param array $args The collected parameters from the hook that was called.
*/
function _wp_call_all_hook($args) {
global $wp_filter;
- reset( $wp_filter['all'] );
- do {
- foreach( (array) current($wp_filter['all']) as $the_ )
- if ( !is_null($the_['function']) )
- call_user_func_array($the_['function'], $args);
-
- } while ( next($wp_filter['all']) !== false );
+ $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 an a new property in
+ * 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
* need to be added.
*
@@ -865,21 +854,22 @@ function _wp_call_all_hook($args) {
* Functions and static method callbacks are just returned as strings and
* shouldn't have any speed penalty.
*
- * @link http://trac.wordpress.org/ticket/3875
+ * @link https://core.trac.wordpress.org/ticket/3875
*
* @since 2.2.3
* @access private
*
* @global array $wp_filter Storage for all of the filters and actions.
+ * @staticvar int $filter_id_count
*
* @param string $tag Used in counting how many hooks were applied
- * @param callback $function Used for creating unique id
+ * @param callable $function Used for creating unique id
* @param int|bool $priority Used in counting how many hooks were applied. If === false
* and $function is an object reference, we return the unique
* id only if it already has one, false otherwise.
- * @return string|bool Unique ID for usage as array key or false if $priority === false
- * and $function is an object reference, and it does not already have
- * a unique id.
+ * @return string|false Unique ID for usage as array key or false if $priority === false
+ * and $function is an object reference, and it does not already have
+ * a unique id.
*/
function _wp_filter_build_unique_id($tag, $function, $priority) {
global $wp_filter;
@@ -913,7 +903,7 @@ function _wp_filter_build_unique_id($tag, $function, $priority) {
return $obj_idx;
}
- } else if ( is_string($function[0]) ) {
+ } elseif ( is_string( $function[0] ) ) {
// Static Calling
return $function[0] . '::' . $function[1];
}