WordPress.org

Make WordPress Core


Ignore:
Timestamp:
09/03/2007 11:32:58 PM (13 years ago)
Author:
ryan
Message:

Remove trailing whitespace

File:
1 edited

Legend:

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

    r6025 r6026  
    33/**
    44 * Hooks a function to a specific filter action.
    5  * 
     5 *
    66 * Filters are the hooks that WordPress launches to modify text of various types
    7  * before adding it to the database or sending it to the browser screen. Plugins 
    8  * can specify that one or more of its PHP functions is executed to 
     7 * before adding it to the database or sending it to the browser screen. Plugins
     8 * can specify that one or more of its PHP functions is executed to
    99 * modify specific types of text at these times, using the Filter API.
    10  * See the [Plugin API] for a list of filter hooks. 
     10 * See the [Plugin API] for a list of filter hooks.
    1111 *
    1212 * @param string $tag The name of the filter to hook the <tt>$function_to_add</tt> to.
     
    2929/**
    3030 * Call the functions added to a filter hook.
    31  * 
     31 *
    3232 * The callback functions attached to filter hook <tt>$tag</tt> are invoked by
    3333 * calling this function. This function can be used to create a new filter hook
     
    6767/**
    6868 * Merge the filter functions of a specific filter hook with generic filter functions.
    69  * 
    70  * It is possible to defined generic filter functions using the filter hook 
    71  * <em>all</e>. These functions are called for every filter tag. This function 
     69 *
     70 * It is possible to defined generic filter functions using the filter hook
     71 * <em>all</e>. These functions are called for every filter tag. This function
    7272 * merges the functions attached to the <em>all</em> hook with the functions
    7373 * of a specific hoook defined by <tt>$tag</tt>.
     
    8888
    8989/**
    90  * Removes a function from a specified filter hook. 
    91  * 
    92  * This function removes a function attached to a specified filter hook. This 
    93  * method can be used to remove default functions attached to a specific filter 
     90 * Removes a function from a specified filter hook.
     91 *
     92 * This function removes a function attached to a specified filter hook. This
     93 * method can be used to remove default functions attached to a specific filter
    9494 * hook and possibly replace them with a substitute.
    9595 * @param string $tag The filter hook to which the function to be removed is hooked.
     
    112112/**
    113113 * Hooks a function on to a specific action.
    114  * 
    115  * Actions are the hooks that the WordPress core launches at specific points 
     114 *
     115 * Actions are the hooks that the WordPress core launches at specific points
    116116 * during execution, or when specific events occur. Plugins can specify that
    117  * one or more of its PHP functions are executed at these points, using the 
     117 * one or more of its PHP functions are executed at these points, using the
    118118 * Action API.
    119  * 
     119 *
    120120 * @param string $tag The name of the action to which the <tt>$function_to-add</tt> is hooked.
    121121 * @param callback $function_to_add The name of the function you wish to be called. 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.
    122122 * @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.
    123  * @param int $accepted_args optional. The number of arguments the function accept (default 1). 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. 
     123 * @param int $accepted_args optional. The number of arguments the function accept (default 1). 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.
    124124 * @return boolean Always true.
    125125 */
     
    130130/**
    131131 * Execute functions hooked on a specific action hook.
    132  * 
     132 *
    133133 * This function invokes all functions attached to action hook <tt>$tag</tt>.
    134134 * It is possible to create new action hooks by simply calling this function,
     
    136136 * @uses merge_filters
    137137 * @param string $tag The name of the action to be executed.
    138  * @param mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the action. 
     138 * @param mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the action.
    139139 */
    140140function do_action($tag, $arg = '') {
     
    184184/**
    185185 * Execute functions hooked on a specific action hook, specifying arguments in a array.
    186  * 
    187  * This function is identical to {@link do_action}, but the argumetns passe to 
     186 *
     187 * This function is identical to {@link do_action}, but the argumetns passe to
    188188 * the functions hooked to <tt>$tag</tt> are supplied using an array.
    189189 * @param string $tag The name of the action to be executed.
     
    213213
    214214/**
    215  * Removes a function from a specified action hook. 
    216  * 
    217  * This function removes a function attached to a specified action hook. This 
    218  * method can be used to remove default functions attached to a specific filter 
     215 * Removes a function from a specified action hook.
     216 *
     217 * This function removes a function attached to a specified action hook. This
     218 * method can be used to remove default functions attached to a specific filter
    219219 * hook and possibly replace them with a substitute.
    220220 * @param string $tag The action hook to which the function to be removed is hooked.
     
    234234/**
    235235 * Gets the basename of a plugin.
    236  * 
     236 *
    237237 * This method extract the name of a plugin from its filename.
    238238 * @param string $file The filename of plugin.
     
    248248/**
    249249 * Hook a function on a plugin activation action hook.
    250  * 
     250 *
    251251 * When a plugin is activated, the action 'activate_PLUGINNAME' hook is
    252252 * activated. In the name of this hook, PLUGINNAME is replaced with the name of
    253253 * the plugin, including the optional subdirectory. For example, when the plugin
    254  * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the 
    255  * name of this hook will become 'activate_sampleplugin/sample.php'. 
    256  * When the plugin consists of only one file and is (as by default) located at 
    257  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be 
     254 * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the
     255 * name of this hook will become 'activate_sampleplugin/sample.php'.
     256 * When the plugin consists of only one file and is (as by default) located at
     257 * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
    258258 * 'activate_sample.php'.
    259259 * @param string $file The filename of the plugin including the path.
     
    267267/**
    268268 * Hook a function on a plugin deactivation action hook.
    269  * 
     269 *
    270270 * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is
    271271 * deactivated. In the name of this hook, PLUGINNAME is replaced with the name of
    272272 * the plugin, including the optional subdirectory. For example, when the plugin
    273  * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the 
    274  * name of this hook will become 'activate_sampleplugin/sample.php'. 
    275  * When the plugin consists of only one file and is (as by default) located at 
    276  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be 
     273 * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the
     274 * name of this hook will become 'activate_sampleplugin/sample.php'.
     275 * When the plugin consists of only one file and is (as by default) located at
     276 * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
    277277 * 'activate_sample.php'.
    278278 * @param string $file The filename of the plugin including the path.
Note: See TracChangeset for help on using the changeset viewer.