Make WordPress Core


Ignore:
Timestamp:
08/30/2008 09:23:43 PM (16 years ago)
Author:
westi
Message:

phpDoc corrections for wp-includes. See #7550 props jacobsantos.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/wp-includes/plugin.php

    r8660 r8782  
    1212 * type are valid.
    1313 *
    14  * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for more information
    15  * and examples on how to use a lot of these functions.
     14 * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for
     15 * more information and examples on how to use a lot of these functions.
    1616 *
    1717 * @package WordPress
     
    2828 * modify specific types of text at these times, using the Filter API.
    2929 *
    30  * To use the API, the following code should be used to bind a callback to the filter
     30 * To use the API, the following code should be used to bind a callback to the
     31 * filter.
     32 *
    3133 * <code>
    3234 * function example_hook($example) { echo $example; }
    33  *
    3435 * add_filter('example_filter', 'example_hook');
    3536 * </code>
    3637 *
    37  * In WordPress 1.5.1+, hooked functions can take extra arguments that are set when
    38  * the matching do_action() or apply_filters() call is run. The <tt>$accepted_args
    39  * allow for calling functions only when the number of args match. Hooked functions
    40  * can take extra arguments that are set when the matching <tt>do_action()</tt> or
    41  * <tt>apply_filters()</tt> call is run. For example, the action <tt>comment_id_not_found</tt>
    42  * will pass any functions that hook onto it the ID of the requested comment.
    43  *
    44  * <strong>Note:</strong> the function will return true no matter if the function was hooked
    45  * fails or not. There are no checks for whether the function exists beforehand and no checks
    46  * to whether the <tt>$function_to_add is even a string. It is up to you to take care and
    47  * this is done for optimization purposes, so everything is as quick as possible.
     38 * In WordPress 1.5.1+, hooked functions can take extra arguments that are set
     39 * when the matching do_action() or apply_filters() call is run. The
     40 * $accepted_args allow for calling functions only when the number of args
     41 * match. Hooked functions can take extra arguments that are set when the
     42 * matching do_action() or apply_filters() call is run. For example, the action
     43 * comment_id_not_found will pass any functions that hook onto it the ID of the
     44 * requested comment.
     45 *
     46 * <strong>Note:</strong> the function will return true no matter if the
     47 * function was hooked fails or not. There are no checks for whether the
     48 * function exists beforehand and no checks to whether the <tt>$function_to_add
     49 * is even a string. It is up to you to take care and this is done for
     50 * optimization purposes, so everything is as quick as possible.
    4851 *
    4952 * @package WordPress
     
    5457 * @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.
    5558 *
    56  * @param string $tag The name of the filter to hook the <tt>$function_to_add</tt> to.
     59 * @param string $tag The name of the filter to hook the $function_to_add to.
    5760 * @param callback $function_to_add The name of the function to be called when the filter is applied.
    5861 * @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.
     
    102105 * Call the functions added to a filter hook.
    103106 *
    104  * The callback functions attached to filter hook <tt>$tag</tt> are invoked by
    105  * calling this function. This function can be used to create a new filter hook
    106  * by simply calling this function with the name of the new hook specified using
    107  * the <tt>$tag</a> parameter.
     107 * The callback functions attached to filter hook $tag are invoked by calling
     108 * this function. This function can be used to create a new filter hook by
     109 * simply calling this function with the name of the new hook specified using
     110 * the $tag parameter.
    108111 *
    109112 * The function allows for additional arguments to be added and passed to hooks.
     
    233236
    234237/**
    235  * Return the name of the current filter or action.
     238 * Retrieve the name of the current filter or action.
    236239 *
    237240 * @package WordPress
     
    261264 * @since 1.2
    262265 *
    263  * @param string $tag The name of the action to which the <tt>$function_to-add</tt> is hooked.
     266 * @param string $tag The name of the action to which the $function_to_add is hooked.
    264267 * @param callback $function_to_add The name of the function you wish to be called.
    265268 * @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.
     
    274277 * Execute functions hooked on a specific action hook.
    275278 *
    276  * This function invokes all functions attached to action hook <tt>$tag</tt>.
    277  * It is possible to create new action hooks by simply calling this function,
     279 * This function invokes all functions attached to action hook $tag. It is
     280 * possible to create new action hooks by simply calling this function,
    278281 * specifying the name of the new hook using the <tt>$tag</tt> parameter.
    279282 *
    280  * You can pass extra arguments to the hooks, much like you can with apply_filters().
    281  *
    282  * @see apply_filters() This function works similar with the exception that nothing is
    283  * returned and only the functions or methods are called.
     283 * You can pass extra arguments to the hooks, much like you can with
     284 * apply_filters().
     285 *
     286 * @see apply_filters() This function works similar with the exception that
     287 * nothing is returned and only the functions or methods are called.
    284288 *
    285289 * @package WordPress
     
    341345
    342346/**
    343  * Return the number times an action is fired.
     347 * Retrieve the number times an action is fired.
    344348 *
    345349 * @package WordPress
     
    363367 * Execute functions hooked on a specific action hook, specifying arguments in an array.
    364368 *
    365  * @see do_action() This function is identical, but the arguments passed to
    366  * the functions hooked to <tt>$tag</tt> are supplied using an array.
     369 * @see do_action() This function is identical, but the arguments passed to the
     370 * functions hooked to <tt>$tag</tt> are supplied using an array.
    367371 *
    368372 * @package WordPress
     
    499503 * activated. In the name of this hook, PLUGINNAME is replaced with the name of
    500504 * the plugin, including the optional subdirectory. For example, when the plugin
    501  * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the
    502  * name of this hook will become 'activate_sampleplugin/sample.php'
    503  * When the plugin consists of only one file and is (as by default) located at
    504  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
     505 * is located in wp-content/plugin/sampleplugin/sample.php, then the name of
     506 * this hook will become 'activate_sampleplugin/sample.php'. When the plugin
     507 * consists of only one file and is (as by default) located at
     508 * wp-content/plugin/sample.php the name of this hook will be
    505509 * 'activate_sample.php'.
    506510 *
     
    525529 * deactivated. In the name of this hook, PLUGINNAME is replaced with the name
    526530 * of the plugin, including the optional subdirectory. For example, when the
    527  * plugin is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then
     531 * plugin is located in wp-content/plugin/sampleplugin/sample.php, then
    528532 * the name of this hook will become 'activate_sampleplugin/sample.php'.
    529533 *
    530534 * When the plugin consists of only one file and is (as by default) located at
    531  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
     535 * wp-content/plugin/sample.php the name of this hook will be
    532536 * 'activate_sample.php'.
    533537 *
     
    632636 * @package WordPress
    633637 * @subpackage Plugin
     638 * @access private
    634639 * @since 2.2.3
    635  *
    636640 * @link http://trac.wordpress.org/ticket/3875
    637  *
    638  * @access private
    639641 *
    640642 * @global array $wp_filter Storage for all of the filters and actions
Note: See TracChangeset for help on using the changeset viewer.