Changeset 6276

Timestamp:

10/19/07 17:45:08 (1 year ago)

Author:

ryan

Message:

phpdoc for plugin API. Props darkdragon. fixes #5225

Files:

• trunk/wp-includes/plugin.php (modified) (19 diffs)

trunk/wp-includes/plugin.php

@@ -1 +1 @@
-<?php
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- *
- * Filters are the hooks that WordPress launches to modify text of various types
@@ -8 +37 @@
- * 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.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- *
- * @param string $tag The name of the filter to hook the <tt>$function_to_add</tt> 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.
- 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.
- if the <tt>$function_to_add</tt> is added succesfully to filter <tt>$tag</tt>. How many arguments your function takes. In WordPress 1.5.1+, hooked functions can take extra arguments that are set when the matching <tt>do_action()</tt> or <tt>apply_filters()</tt> call is run. For example, the action <tt>comment_id_not_found</tt> will pass any functions that hook onto it the ID of the requested comment.
+
+
- */
-function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
-    global $wp_filter, $merged_filters;
-
-    // So the format is wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)]']
-    $idx = _wp_filter_build_unique_id($tag, $function_to_add, $priority);
-
-
+
-    unset( $merged_filters[ $tag ] );
-    return true;
@@ -34 +86 @@
- * by simply calling this function with the name of the new hook specified using
- * the <tt>$tag</a> parameter.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- * @param string $tag The name of the filter hook.
-string The text
+value The value
- * @param mixed $var,... Additional variables passed to the functions hooked to <tt>$tag</tt>.
- * @return string The text in <tt>$string</tt> after all hooked functions are applied to it.
- */
-string
+value
-    global $wp_filter, $merged_filters;
-
@@ -47 +114 @@
-
-    if ( !isset($wp_filter[$tag]) )
-string
+value
-
-    reset( $wp_filter[ $tag ] );
@@ -56 +123 @@
-        foreach( (array) current($wp_filter[$tag]) as $the_ )
-            if ( !is_null($the_['function']) ){
-string
-string
+value
+value
-            }
-
-    } while ( next($wp_filter[$tag]) !== false );
-
-string
+value
-}
-
@@ -71 +138 @@
- * <em>all</e>. These functions are called for every filter tag. This function
- * merges the functions attached to the <em>all</em> hook with the functions
-
+
+
+
+
+
+
+
+
+
+
+
- * @param string $tag The filter hook of which the functions should be merged.
- */
@@ -93 +170 @@
- * method can be used to remove default functions attached to a specific filter
- * hook and possibly replace them with a substitute.
+ *
+ * To remove a hook, the <tt>$function_to_remove</tt> and <tt>$priority</tt> arguments
+ * must match when the hook was added. This goes for both filters and actions. No warning
+ * will be given on removal failure.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 1.5
+ *
- * @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).
-i
+existed before it wa
- */
-function remove_filter($tag, $function_to_remove, $priority = 10, $accepted_args = 1) {
@@ -118 +204 @@
- * Action API.
- *
+ * @uses add_filter() Adds an action. Parameter list and functionality are the same.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 1.5
+ *
- * @param string $tag The name of the action to which the <tt>$function_to-add</tt> is hooked.
- Note: any of the syntaxes explained in the PHP documentation for the 'callback' type (http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback) are valid.
+
- * @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.
-
-
+
- */
-function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) {
@@ -134 +225 @@
- * It is possible to create new action hooks by simply calling this function,
- * specifying the name of the new hook using the <tt>$tag</tt> parameter.
-
+
+
+
+
+
+
+
+
+
+
+
+
- * @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.
+ * @return null Will return null if $tag does not exist in $wp_filter array
- */
-function do_action($tag, $arg = '') {
@@ -170 +273 @@
-/**
- * Return the number times an action is fired.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 2.1
+ * @global array $wp_actions Increments the amount of times action was triggered.
+ *
- * @param string $tag The name of the action hook.
- * @return int The number of times action hook <tt>$tag</tt> is fired
@@ -183 +292 @@
-
-/**
-
-
-This function is identical to {@link do_action}, but the argumetns passe
+n
+
+@see do_action() This function is identical, but the arguments passed
- * the functions hooked to <tt>$tag</tt> are supplied using an array.
+ *
+ * @uses merge_filters()
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 2.1
+ * @global array $wp_filter Stores all of the filters
+ * @global array $wp_actions Increments the amount of times action was triggered.
+ *
- * @param string $tag The name of the action to be executed.
- * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
+ * @return null Will return null if $tag does not exist in $wp_filter array
- */
-function do_action_ref_array($tag, $args) {
@@ -218 +337 @@
- * method can be used to remove default functions attached to a specific filter
- * hook and possibly replace them with a substitute.
+ *
+ * @uses remove_filter() Uses remove_filter to remove actions added.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 1.5
+ *
- * @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.
@@ -236 +362 @@
- *
- * This method extract the name of a plugin from its filename.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 1.5
+ *
+ * @access private
+ *
- * @param string $file The filename of plugin.
- * @return string The name of a plugin.
@@ -253 +386 @@
- * the plugin, including the optional subdirectory. For example, when the plugin
- * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the
-.
+
- * When the plugin consists of only one file and is (as by default) located at
- * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
- * 'activate_sample.php'.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 1.5
+ *
+ * @access private
+ *
- * @param string $file The filename of the plugin including the path.
- * @param string $function the function hooked to the 'activate_PLUGIN' action.
@@ -276 +416 @@
- * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
- * 'activate_sample.php'.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 2.0
+ *
+ * @access private
+ *
- * @param string $file The filename of the plugin including the path.
- * @param string $function the function hooked to the 'activate_PLUGIN' action.
@@ -285 +432 @@
-
-/**
+ * 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
+ * the class to keep track of the object and new objects of the same class that
+ * need to be added.
+ *
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Plugin
+ * @since 2.2.3
+ *
+ * @link http://trac.wordpress.org/ticket/3875
+ *
- * @access private
- *
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
- * @param string $tag Used in counting how many hooks were applied
- * @param string|array $function Used for creating unique id
@@ -316 +467 @@
-
-    // If function then just skip all of the tests and not overwrite the following.
-    // Static Calling
-    if( is_string($function) )
-        return $function;
@@ -323 +473 @@
-    {
-        $obj_idx = get_class($function[0]).$function[1];
-
+ // This should be instead of is_null() change to !isset() to fix notice
-            $count = count((array)$wp_filter[$tag][$priority]);
-            $function[0]->wp_filter_id = $count;
@@ -332 +482 @@
-        return $obj_idx;
-    }
+    // Static Calling
-    else if( is_string($function[0]) )
-        return $function[0].$function[1];