X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/f9001779751f83dc8a10e478bfecb4d8dd5f964c..61343b82c4f0da4c68e4c6373daafff4a81efdd1:/wp-includes/plugin.php diff --git a/wp-includes/plugin.php b/wp-includes/plugin.php index 0c10e242..c2aebf28 100644 --- a/wp-includes/plugin.php +++ b/wp-includes/plugin.php @@ -45,7 +45,7 @@ * * Note: the function will return true no matter if the * function was hooked fails or not. There are no checks for whether the - * function exists beforehand and no checks to whether the $function_to_add + * function exists beforehand and no checks to whether the $function_to_add * is even a string. It is up to you to take care and this is done for * optimization purposes, so everything is as quick as possible. * @@ -80,8 +80,11 @@ 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 $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached. - * @return int|boolean Optionally returns the priority on that hook for the specified function. + * @param callback $function_to_check optional. + * @return mixed 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) { global $wp_filter; @@ -135,19 +138,23 @@ function apply_filters($tag, $value) { global $wp_filter, $merged_filters, $wp_current_filter; $args = array(); - $wp_current_filter[] = $tag; // Do 'all' actions first if ( isset($wp_filter['all']) ) { + $wp_current_filter[] = $tag; $args = func_get_args(); _wp_call_all_hook($args); } if ( !isset($wp_filter[$tag]) ) { - array_pop($wp_current_filter); + if ( isset($wp_filter['all']) ) + array_pop($wp_current_filter); return $value; } + if ( !isset($wp_filter['all']) ) + $wp_current_filter[] = $tag; + // Sort if ( !isset( $merged_filters[ $tag ] ) ) { ksort($wp_filter[$tag]); @@ -193,19 +200,22 @@ function apply_filters($tag, $value) { function apply_filters_ref_array($tag, $args) { global $wp_filter, $merged_filters, $wp_current_filter; - $wp_current_filter[] = $tag; - // Do 'all' actions first if ( isset($wp_filter['all']) ) { + $wp_current_filter[] = $tag; $all_args = func_get_args(); _wp_call_all_hook($all_args); } if ( !isset($wp_filter[$tag]) ) { - array_pop($wp_current_filter); + if ( isset($wp_filter['all']) ) + array_pop($wp_current_filter); return $args[0]; } + if ( !isset($wp_filter['all']) ) + $wp_current_filter[] = $tag; + // Sort if ( !isset( $merged_filters[ $tag ] ) ) { ksort($wp_filter[$tag]); @@ -244,10 +254,10 @@ function apply_filters_ref_array($tag, $args) { * @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 int $priority optional. The priority of the function (default: 10). - * @param int $accepted_args optional. The number of arguments the function accpets (default: 1). + * @param int $accepted_args optional. The number of arguments the function accepts (default: 1). * @return boolean Whether the function existed before it was removed. */ -function remove_filter($tag, $function_to_remove, $priority = 10, $accepted_args = 1) { +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]); @@ -301,7 +311,6 @@ function current_filter() { return end( $wp_current_filter ); } - /** * Hooks a function on to a specific action. * @@ -325,7 +334,6 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) return add_filter($tag, $function_to_add, $priority, $accepted_args); } - /** * Execute functions hooked on a specific action hook. * @@ -360,19 +368,22 @@ function do_action($tag, $arg = '') { else ++$wp_actions[$tag]; - $wp_current_filter[] = $tag; - // Do 'all' actions first if ( isset($wp_filter['all']) ) { + $wp_current_filter[] = $tag; $all_args = func_get_args(); _wp_call_all_hook($all_args); } if ( !isset($wp_filter[$tag]) ) { - array_pop($wp_current_filter); + if ( isset($wp_filter['all']) ) + array_pop($wp_current_filter); return; } + if ( !isset($wp_filter['all']) ) + $wp_current_filter[] = $tag; + $args = array(); if ( is_array($arg) && 1 == count($arg) && isset($arg[0]) && is_object($arg[0]) ) // array(&$this) $args[] =& $arg[0]; @@ -400,7 +411,7 @@ function do_action($tag, $arg = '') { } /** - * Retrieve the number times an action is fired. + * Retrieve the number of times an action is fired. * * @package WordPress * @subpackage Plugin @@ -446,19 +457,22 @@ function do_action_ref_array($tag, $args) { else ++$wp_actions[$tag]; - $wp_current_filter[] = $tag; - // Do 'all' actions first if ( isset($wp_filter['all']) ) { + $wp_current_filter[] = $tag; $all_args = func_get_args(); _wp_call_all_hook($all_args); } if ( !isset($wp_filter[$tag]) ) { - array_pop($wp_current_filter); + if ( isset($wp_filter['all']) ) + array_pop($wp_current_filter); return; } + if ( !isset($wp_filter['all']) ) + $wp_current_filter[] = $tag; + // Sort if ( !isset( $merged_filters[ $tag ] ) ) { ksort($wp_filter[$tag]); @@ -486,8 +500,11 @@ 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 $function_to_check optional. If specified, return the priority of that function on this hook or false if not attached. - * @return int|boolean Optionally returns the priority on that hook for the specified function. + * @param callback $function_to_check optional. + * @return mixed 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_action($tag, $function_to_check = false) { return has_filter($tag, $function_to_check); @@ -507,11 +524,10 @@ function has_action($tag, $function_to_check = false) { * @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 int $priority optional The priority of the function (default: 10). - * @param int $accepted_args optional. The number of arguments the function accpets (default: 1). * @return boolean Whether the function is removed. */ -function remove_action($tag, $function_to_remove, $priority = 10, $accepted_args = 1) { - return remove_filter($tag, $function_to_remove, $priority, $accepted_args); +function remove_action( $tag, $function_to_remove, $priority = 10 ) { + return remove_filter( $tag, $function_to_remove, $priority ); } /** @@ -588,12 +604,13 @@ function plugin_dir_url( $file ) { * Set the activation hook for a plugin. * * When a plugin is activated, the action 'activate_PLUGINNAME' hook is - * activated. 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/plugin/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/plugin/sample.php the name of this hook will be + * 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 * 'activate_sample.php'. * * @package WordPress @@ -612,21 +629,21 @@ function register_activation_hook($file, $function) { * Set the deactivation hook for a plugin. * * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is - * deactivated. In the name of this hook, PLUGINNAME is replaced with the name + * 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/plugin/sampleplugin/sample.php, then - * the name of this hook will become 'activate_sampleplugin/sample.php'. + * 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/plugin/sample.php the name of this hook will be - * 'activate_sample.php'. + * wp-content/plugins/sample.php the name of this hook will be + * 'deactivate_sample.php'. * * @package WordPress * @subpackage Plugin * @since 2.0 * * @param string $file The filename of the plugin including the path. - * @param callback $function the function hooked to the 'activate_PLUGIN' action. + * @param callback $function the function hooked to the 'deactivate_PLUGIN' action. */ function register_deactivation_hook($file, $function) { $file = plugin_basename($file); @@ -731,8 +748,8 @@ function _wp_call_all_hook($args) { * @global array $wp_filter Storage for all of the filters and actions * @param string $tag Used in counting how many hooks were applied * @param callback $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 uniqe 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. */ function _wp_filter_build_unique_id($tag, $function, $priority) { global $wp_filter; @@ -768,8 +785,6 @@ function _wp_filter_build_unique_id($tag, $function, $priority) { } } else if ( is_string($function[0]) ) { // Static Calling - return $function[0].$function[1]; + return $function[0] . '::' . $function[1]; } } - -?>