X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/6c8f14c09105d0afa4c1574215c59b5021040e76..fa11948979fd6a4ea5705dc613b239699a459db3:/wp-includes/plugin.php
diff --git a/wp-includes/plugin.php b/wp-includes/plugin.php
index 7e387080..df4ba8d3 100644
--- a/wp-includes/plugin.php
+++ b/wp-includes/plugin.php
@@ -19,50 +19,67 @@
* @since 1.5
*/
+// Initialize the filter globals.
+global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
+
+if ( ! isset( $wp_filter ) )
+ $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();
+
/**
* Hooks a function or method to a specific filter action.
*
- * Filters are the hooks that WordPress launches to modify text of various types
- * before adding it to the database or sending it to the browser screen. Plugins
- * can specify that one or more of its PHP functions is executed to
- * modify specific types of text at these times, using the Filter API.
+ * WordPress offers filter hooks to allow plugins to modify
+ * various types of internal data at runtime.
+ *
+ * A plugin can modify data by binding a callback to a filter hook. When the filter
+ * is later applied, each bound callback is run in order of priority, and given
+ * the opportunity to modify a value by returning a new value.
*
- * To use the API, the following code should be used to bind a callback to the
- * filter.
+ * 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_hook($example) { echo $example; }
- * add_filter('example_filter', 'example_hook');
+ * function example_callback( $example ) {
+ * // Maybe modify $example in some way
+ * return $example;
+ * }
+ * add_filter( 'example_filter', 'example_callback' );
*
*
- * In WordPress 1.5.1+, hooked functions can take extra arguments that are set
- * when the matching do_action() or apply_filters() call is run. The
- * $accepted_args allow for calling functions only when the number of args
- * match. Hooked functions can take extra arguments that are set when the
- * matching do_action() or apply_filters() call is run. For example, the action
- * comment_id_not_found will pass any functions that hook onto it the ID of the
- * requested comment.
+ * 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.
*
- * 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
- * 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.
+ * 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.
*
* @package WordPress
* @subpackage Plugin
- * @since 0.71
- * @global array $wp_filter Stores all of the filters added in the form of
- * wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)']']
+ *
+ * @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 to.
- * @param callback $function_to_add The name of the function to be called 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 accept (default 1).
+ * @since 0.71
+ *
+ * @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 int $priority (optional) The order in which the functions associated with a particular action are executed. 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.
+ * Default 10.
+ * @param int $accepted_args (optional) The number of arguments the function accepts.
+ * Default 1.
* @return boolean true
*/
-function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
+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);
@@ -114,27 +131,36 @@ function has_filter($tag, $function_to_check = false) {
*
* The function allows for additional arguments to be added and passed to hooks.
*
- * function example_hook($string, $arg1, $arg2)
- * {
- * //Do stuff
- * return $string;
+ * // Our filter callback function
+ * function example_callback( $string, $arg1, $arg2 ) {
+ * // (maybe) modify $string
+ * return $string;
* }
- * $value = apply_filters('example_filter', 'filter me', 'arg1', 'arg2');
+ * 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 );
*
*
* @package WordPress
* @subpackage Plugin
- * @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_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.
+ * @since 0.71
+ *
+ * @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 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) {
+function apply_filters( $tag, $value ) {
global $wp_filter, $merged_filters, $wp_current_filter;
$args = array();
@@ -360,9 +386,6 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
function do_action($tag, $arg = '') {
global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
- if ( ! isset($wp_actions) )
- $wp_actions = array();
-
if ( ! isset($wp_actions[$tag]) )
$wp_actions[$tag] = 1;
else
@@ -424,7 +447,7 @@ function do_action($tag, $arg = '') {
function did_action($tag) {
global $wp_actions;
- if ( ! isset( $wp_actions ) || ! isset( $wp_actions[$tag] ) )
+ if ( ! isset( $wp_actions[ $tag ] ) )
return 0;
return $wp_actions[$tag];
@@ -449,9 +472,6 @@ function did_action($tag) {
function do_action_ref_array($tag, $args) {
global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
- if ( ! isset($wp_actions) )
- $wp_actions = array();
-
if ( ! isset($wp_actions[$tag]) )
$wp_actions[$tag] = 1;
else
@@ -604,12 +624,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
@@ -628,21 +649,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);
@@ -707,7 +728,6 @@ function register_uninstall_hook( $file, $callback ) {
* @uses $wp_filter Used to process all of the functions in the 'all' hook
*
* @param array $args The collected parameters from the hook that was called.
- * @param string $hook Optional. The hook name that was used to call the 'all' hook.
*/
function _wp_call_all_hook($args) {
global $wp_filter;
@@ -784,6 +804,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];
}
}