WordPress.org
Get WordPress

Make WordPress Core

Changeset 28888


Ignore:
Timestamp:
06/29/2014 08:41:38 AM (11 years ago)
Author:
SergeyBiryukov
Message:

More tweaks to @param docs in wp-includes/plugin.php.

see #28516.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/plugin.php

    r28886 r28888  
    7171 * @param string   $tag             The name of the filter to hook the $function_to_add callback to.
    7272 * @param callback $function_to_add The callback to be run when the filter is applied.
    73  * @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.
    74  *                                  Default 10.
    75  * @param int      $accepted_args   (optional) The number of arguments the function accepts.
    76  *                                  Default 1.
     73 * @param int      $priority        Optional. Used to specify the order in which the functions
     74 *                                  associated with a particular action are executed. Default 10.
     75 *                                  Lower numbers correspond with earlier execution,
     76 *                                  and functions with the same priority are executed
     77 *                                  in the order in which they were added to the action.
     78 * @param int      $accepted_args   Optional. The number of arguments the function accepts. Default 1.
    7779 * @return boolean true
    7880 */
    … …  
    9395 * @global array $wp_filter Stores all of the filters
    9496 *
    95  * @param string $tag The name of the filter hook.
    96  * @param bool|callback $function_to_check optional.
     97 * @param string        $tag              The name of the filter hook.
     98 * @param bool|callback $function_to_check Optional. The callback to check for. Default false.
    9799 * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.
    98100 *  When checking a specific function, the priority of that hook is returned, or false if the function is not attached.
    … …  
    143145 * </code>
    144146 *
    145  * @global array $wp_filter         Stores all of the filters
     147 * @global array $wp_filter         Stores all of the filters.
    146148 * @global array $merged_filters    Merges the filter hooks using this function.
    147  * @global array $wp_current_filter stores the list of current filters with the current one last
     149 * @global array $wp_current_filter Stores the list of current filters with the current one last.
    148150 *
    149151 * @since 0.71
    150152 *
    151  * @param string $tag  The name of the filter hook.
    152  * @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
    153  * @param mixed $var   Additional variables passed to the functions hooked to <tt>$tag</tt>.
     153 * @param string $tag   The name of the filter hook.
     154 * @param mixed  $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
     155 * @param mixed  $var   Additional variables passed to the functions hooked to <tt>$tag</tt>.
    154156 * @return mixed The filtered value after all hooked functions are applied to it.
    155157 */
    … …  
    211213 * @global array $wp_current_filter stores the list of current filters with the current one last
    212214 *
    213  * @param string $tag The name of the filter hook.
    214  * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
     215 * @param string $tag  The name of the filter hook.
     216 * @param array  $args The arguments supplied to the functions hooked to <tt>$tag</tt>.
    215217 * @return mixed The filtered value after all hooked functions are applied to it.
    216218 */
    … …  
    267269 * @since 1.2.0
    268270 *
    269  * @param string $tag The filter hook to which the function to be removed is hooked.
     271 * @param string   $tag                The filter hook to which the function to be removed is hooked.
    270272 * @param callback $function_to_remove The name of the function which should be removed.
    271  * @param int $priority optional. The priority of the function (default: 10).
     273 * @param int      $priority           Optional. The priority of the function. Default 10.
    272274 * @return boolean Whether the function existed before it was removed.
    273275 */
    … …  
    296298 * @since 2.7.0
    297299 *
    298  * @param string $tag The filter to remove hooks from.
    299  * @param bool|int $priority The priority number to remove.
     300 * @param string   $tag      The filter to remove hooks from.
     301 * @param bool|int $priority Optional. The priority number to remove. Default false.
    300302 * @return bool True when finished.
    301303 */
    … …  
    399401 * @since 1.2.0
    400402 *
    401  * @param string $tag The name of the action to which the $function_to_add is hooked.
     403 * @param string   $tag            The name of the action to which the $function_to_add is hooked.
    402404 * @param callback $function_to_add The name of the function you wish to be called.
    403  * @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.
    404  * @param int $accepted_args optional. The number of arguments the function accept (default 1).
     405 * @param int      $priority        Optional. Used to specify the order in which the functions
     406 *                                  associated with a particular action are executed. Default 10.
     407 *                                  Lower numbers correspond with earlier execution,
     408 *                                  and functions with the same priority are executed
     409 *                                  in the order in which they were added to the action.
     410 * @param int      $accepted_args   Optional. The number of arguments the function accept. Default 1.
    405411 * @return bool Will always return true.
    406412 */
    … …  
    427433 * @global array $wp_actions Increments the amount of times action was triggered.
    428434 *
    429  * @param string $tag The name of the action to be executed.
    430  * @param mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the action.
     435 * @param string $tag      The name of the action to be executed.
     436 * @param mixed  $arg, ... Optional. Additional arguments which are passed on to the functions hooked to the action.
    431437 * @return null Will return null if $tag does not exist in $wp_filter array
    432438 */
    … …  
    511517 * @global array $wp_actions Increments the amount of times action was triggered.
    512518 *
    513  * @param string $tag The name of the action to be executed.
    514  * @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
     519 * @param string $tag  The name of the action to be executed.
     520 * @param array  $args The arguments supplied to the functions hooked to <tt>$tag</tt>
    515521 * @return null Will return null if $tag does not exist in $wp_filter array
    516522 */
    … …  
    564570 * @see has_filter() has_action() is an alias of has_filter().
    565571 *
    566  * @param string $tag The name of the action hook.
    567  * @param bool|callback $function_to_check optional.
     572 * @param string        $tag              The name of the action hook.
     573 * @param bool|callback $function_to_check Optional. The callback to check for. Default false.
    568574 * @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything registered.
    569575 *  When checking a specific function, the priority of that hook is returned, or false if the function is not attached.
    … …  
    584590 * @since 1.2.0
    585591 *
    586  * @param string $tag The action hook to which the function to be removed is hooked.
     592 * @param string   $tag                The action hook to which the function to be removed is hooked.
    587593 * @param callback $function_to_remove The name of the function which should be removed.
    588  * @param int $priority optional The priority of the function (default: 10).
     594 * @param int      $priority           Optional. The priority of the function. Default 10.
    589595 * @return boolean Whether the function is removed.
    590596 */
    … …  
    598604 * @since 2.7.0
    599605 *
    600  * @param string $tag The action to remove hooks from.
    601  * @param bool|int $priority The priority number to remove them from.
     606 * @param string   $tag      The action to remove hooks from.
     607 * @param bool|int $priority The priority number to remove them from. Default false.
    602608 * @return bool True when finished.
    603609 */
Note: See TracChangeset for help on using the changeset viewer.