WordPress.org

Make WordPress Core

Ticket #5225: plugin.phpdoc.3.diff

File plugin.phpdoc.3.diff, 6.0 KB (added by darkdragon, 14 years ago)

Fixes @since information based off of http://planetozh.com/projects/wordpress-functions-history/table_light.html table

  • plugin.php

     
    3030 */
    3131
    3232/**
    33  * Hooks a function or method to a specific filter action.
     33 * add_filter() - Hooks a function or method to a specific filter action.
    3434 *
    3535 * Filters are the hooks that WordPress launches to modify text of various types
    3636 * before adding it to the database or sending it to the browser screen. Plugins
     
    5858 *
    5959 * @package WordPress
    6060 * @subpackage Plugin
    61  * @since 1.5
     61 * @since 0.71
    6262 * @global array $wp_filter Stores all of the filters added in the form of
    6363 *      wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)]']
    6464 * @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.
     
    7979}
    8080
    8181/**
    82  * Call the functions added to a filter hook.
     82 * apply_filters() - Call the functions added to a filter hook.
    8383 *
    8484 * The callback functions attached to filter hook <tt>$tag</tt> are invoked by
    8585 * calling this function. This function can be used to create a new filter hook
     
    9797 *
    9898 * @package WordPress
    9999 * @subpackage Plugin
    100  * @since 1.5
     100 * @since 0.71
    101101 * @global array $wp_filter Stores all of the filters
    102102 * @global array $merge_filters Merges the filter hooks using this function.
    103103 *
     
    132132}
    133133
    134134/**
    135  * Merge the filter functions of a specific filter hook with generic filter functions.
     135 * merge_filters() - Merge the filter functions of a specific filter hook with generic filter functions.
    136136 *
    137137 * It is possible to defined generic filter functions using the filter hook
    138138 * <em>all</e>. These functions are called for every filter tag. This function
     
    164164}
    165165
    166166/**
    167  * Removes a function from a specified filter hook.
     167 * remove_filter() - Removes a function from a specified filter hook.
    168168 *
    169169 * This function removes a function attached to a specified filter hook. This
    170170 * method can be used to remove default functions attached to a specific filter
     
    176176 *
    177177 * @package WordPress
    178178 * @subpackage Plugin
    179  * @since 1.5
     179 * @since 1.2
    180180 *
    181181 * @param string $tag The filter hook to which the function to be removed is hooked.
    182182 * @param callback $function_to_remove The name of the function which should be removed.
     
    196196}
    197197
    198198/**
    199  * Hooks a function on to a specific action.
     199 * add_action() - Hooks a function on to a specific action.
    200200 *
    201201 * Actions are the hooks that the WordPress core launches at specific points
    202202 * during execution, or when specific events occur. Plugins can specify that
     
    207207 *
    208208 * @package WordPress
    209209 * @subpackage Plugin
    210  * @since 1.5
     210 * @since 1.2
    211211 *
    212212 * @param string $tag The name of the action to which the <tt>$function_to-add</tt> is hooked.
    213213 * @param callback $function_to_add The name of the function you wish to be called.
     
    219219}
    220220
    221221/**
    222  * Execute functions hooked on a specific action hook.
     222 * do_action() - Execute functions hooked on a specific action hook.
    223223 *
    224224 * This function invokes all functions attached to action hook <tt>$tag</tt>.
    225225 * It is possible to create new action hooks by simply calling this function,
     
    232232 *
    233233 * @package WordPress
    234234 * @subpackage Plugin
    235  * @since 1.5
     235 * @since 1.2
    236236 * @global array $wp_filter Stores all of the filters
    237237 * @global array $wp_actions Increments the amount of times action was triggered.
    238238 *
     
    271271}
    272272
    273273/**
    274  * Return the number times an action is fired.
     274 * did_action() - Return the number times an action is fired.
    275275 *
    276276 * @package WordPress
    277277 * @subpackage Plugin
     
    291291}
    292292
    293293/**
    294  * Execute functions hooked on a specific action hook, specifying arguments in an array.
     294 * do_action_ref_array() - Execute functions hooked on a specific action hook, specifying arguments in an array.
    295295 *
    296296 * @see do_action() This function is identical, but the arguments passed to
    297297 * the functions hooked to <tt>$tag</tt> are supplied using an array.
     
    331331}
    332332
    333333/**
    334  * Removes a function from a specified action hook.
     334 * remove_action() - Removes a function from a specified action hook.
    335335 *
    336336 * This function removes a function attached to a specified action hook. This
    337337 * method can be used to remove default functions attached to a specific filter
     
    341341 *
    342342 * @package WordPress
    343343 * @subpackage Plugin
    344  * @since 1.5
     344 * @since 1.2
    345345 *
    346346 * @param string $tag The action hook to which the function to be removed is hooked.
    347347 * @param callback $function_to_remove The name of the function which should be removed.
     
    379379}
    380380
    381381/**
    382  * Hook a function on a plugin activation action hook.
     382 * register_activation_hook() - Hook a function on a plugin activation action hook.
    383383 *
    384384 * When a plugin is activated, the action 'activate_PLUGINNAME' hook is
    385385 * activated. In the name of this hook, PLUGINNAME is replaced with the name of
     
    392392 *
    393393 * @package WordPress
    394394 * @subpackage Plugin
    395  * @since 1.5
     395 * @since 2.0
    396396 *
    397397 * @access private
    398398 *
     
    405405}
    406406
    407407/**
    408  * Hook a function on a plugin deactivation action hook.
     408 * register_deactivation_hook() - Hook a function on a plugin deactivation action hook.
    409409 *
    410410 * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is
    411411 * deactivated. In the name of this hook, PLUGINNAME is replaced with the name of
     
    431431}
    432432
    433433/**
    434  * Build Unique ID for storage and retrieval
     434 * _wp_filter_build_unique_id() - Build Unique ID for storage and retrieval
    435435 *
    436436 * The old way to serialize the callback caused issues and this function is the
    437437 * solution. It works by checking for objects and creating an a new property in
     
    486486                return $function[0].$function[1];
    487487}
    488488
    489 ?>
    490  No newline at end of file
     489?>