Make WordPress Core

Changeset 37518


Ignore:
Timestamp:
05/22/2016 06:49:05 PM (8 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in remaining wp-includes/* files to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

Location:
trunk/src/wp-includes
Files:
38 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/admin-bar.php

    r36926 r37518  
    3333
    3434    /**
    35      * Filter the admin bar class to instantiate.
     35     * Filters the admin bar class to instantiate.
    3636     *
    3737     * @since 3.1.0
     
    922922
    923923    /**
    924      * Filter whether to show the admin bar.
     924     * Filters whether to show the admin bar.
    925925     *
    926926     * Returning false to this hook is the recommended way to hide the admin bar.
  • trunk/src/wp-includes/bookmark.php

    r36009 r37518  
    133133            $bookmarks = $cache[ $key ];
    134134            /**
    135              * Filter the returned list of bookmarks.
     135             * Filters the returned list of bookmarks.
    136136             *
    137137             * The first time the hook is evaluated in this file, it returns the cached
  • trunk/src/wp-includes/canonical.php

    r37262 r37518  
    487487
    488488    /**
    489      * Filter the canonical redirect URL.
     489     * Filters the canonical redirect URL.
    490490     *
    491491     * Returning false to this filter will cancel the redirect.
  • trunk/src/wp-includes/capabilities.php

    r37342 r37518  
    250250        if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
    251251            /**
    252              * Filter whether the user is allowed to add post meta to a post.
     252             * Filters whether the user is allowed to add post meta to a post.
    253253             *
    254254             * The dynamic portion of the hook name, `$meta_key`, refers to the
     
    391391
    392392    /**
    393      * Filter a user's capabilities depending on specific context and/or privilege.
     393     * Filters a user's capabilities depending on specific context and/or privilege.
    394394     *
    395395     * @since 2.8.0
  • trunk/src/wp-includes/category.php

    r37431 r37518  
    3131
    3232    /**
    33      * Filter the taxonomy used to retrieve terms when calling get_categories().
     33     * Filters the taxonomy used to retrieve terms when calling get_categories().
    3434     *
    3535     * @since 2.7.0
     
    272272
    273273    /**
    274      * Filter the array of term objects returned for the 'post_tag' taxonomy.
     274     * Filters the array of term objects returned for the 'post_tag' taxonomy.
    275275     *
    276276     * @since 2.3.0
  • trunk/src/wp-includes/class-IXR.php

    r37244 r37518  
    250250        if ( function_exists( 'apply_filters' ) ) {
    251251            /**
    252              * Filter the number of elements to parse in an XML-RPC response.
     252             * Filters the number of elements to parse in an XML-RPC response.
    253253             *
    254254             * @since 4.0.0
     
    274274
    275275        /**
    276          * Filter the chunk size that can be used to parse an XML-RPC reponse message.
     276         * Filters the chunk size that can be used to parse an XML-RPC reponse message.
    277277         *
    278278         * @since 4.4.0
  • trunk/src/wp-includes/class-feed.php

    r36728 r37518  
    3939        $lifetime = $this->lifetime;
    4040        /**
    41          * Filter the transient lifetime of the feed cache.
     41         * Filters the transient lifetime of the feed cache.
    4242         *
    4343         * @since 2.8.0
  • trunk/src/wp-includes/class-oembed.php

    r37431 r37518  
    116116
    117117        /**
    118          * Filter the list of whitelisted oEmbed providers.
     118         * Filters the list of whitelisted oEmbed providers.
    119119         *
    120120         * Since WordPress 4.4, oEmbed discovery is enabled for all users and allows embedding of sanitized
     
    322322
    323323        /**
    324          * Filter the HTML returned by the oEmbed provider.
     324         * Filters the HTML returned by the oEmbed provider.
    325325         *
    326326         * @since 2.9.0
     
    349349
    350350        /**
    351          * Filter oEmbed remote get arguments.
     351         * Filters oEmbed remote get arguments.
    352352         *
    353353         * @since 4.0.0
     
    365365
    366366            /**
    367              * Filter the link types that contain oEmbed provider URLs.
     367             * Filters the link types that contain oEmbed provider URLs.
    368368             *
    369369             * @since 2.9.0
     
    436436
    437437        /**
    438          * Filter the oEmbed URL to be fetched.
     438         * Filters the oEmbed URL to be fetched.
    439439         *
    440440         * @since 2.9.0
     
    599599
    600600        /**
    601          * Filter the returned oEmbed HTML.
     601         * Filters the returned oEmbed HTML.
    602602         *
    603603         * Use this filter to add support for custom data types, or to filter the result.
  • trunk/src/wp-includes/class-walker-category.php

    r37047 r37518  
    112112        if ( $args['use_desc_for_title'] && ! empty( $category->description ) ) {
    113113            /**
    114              * Filter the category description for display.
     114             * Filters the category description for display.
    115115             *
    116116             * @since 1.2.0
     
    190190
    191191            /**
    192              * Filter the list of CSS classes to include with each category in the list.
     192             * Filters the list of CSS classes to include with each category in the list.
    193193             *
    194194             * @since 4.2.0
  • trunk/src/wp-includes/class-walker-page-dropdown.php

    r37054 r37518  
    7676
    7777        /**
    78          * Filter the page title when creating an HTML drop-down list of pages.
     78         * Filters the page title when creating an HTML drop-down list of pages.
    7979         *
    8080         * @since 3.1.0
  • trunk/src/wp-includes/class-walker-page.php

    r37057 r37518  
    117117
    118118        /**
    119          * Filter the list of CSS classes to include with each page item in the list.
     119         * Filters the list of CSS classes to include with each page item in the list.
    120120         *
    121121         * @since 2.8.0
  • trunk/src/wp-includes/class-wp.php

    r37487 r37518  
    147147
    148148        /**
    149          * Filter whether to parse the request.
     149         * Filters whether to parse the request.
    150150         *
    151151         * @since 3.5.0
     
    282282
    283283        /**
    284          * Filter the query variables whitelist before processing.
     284         * Filters the query variables whitelist before processing.
    285285         *
    286286         * Allows (publicly allowed) query vars to be added, removed, or changed prior
     
    369369
    370370        /**
    371          * Filter the array of parsed query variables.
     371         * Filters the array of parsed query variables.
    372372         *
    373373         * @since 2.1.0
     
    464464
    465465        /**
    466          * Filter the HTTP headers before they're sent to the browser.
     466         * Filters the HTTP headers before they're sent to the browser.
    467467         *
    468468         * @since 2.8.0
     
    533533        if ( has_filter( 'query_string' ) ) {  // Don't bother filtering and parsing if no plugins are hooked in.
    534534            /**
    535              * Filter the query string before parsing.
     535             * Filters the query string before parsing.
    536536             *
    537537             * @since 1.5.0
     
    632632
    633633        /**
    634          * Filter whether to short-circuit default header status handling.
     634         * Filters whether to short-circuit default header status handling.
    635635         *
    636636         * Returning a non-false value from the filter will short-circuit the handling
  • trunk/src/wp-includes/class.wp-scripts.php

    r37171 r37518  
    287287        if ( $this->do_concat ) {
    288288            /**
    289              * Filter the script loader source.
     289             * Filters the script loader source.
    290290             *
    291291             * @since 2.2.0
     
    346346
    347347        /**
    348          * Filter the HTML script tag of an enqueued script.
     348         * Filters the HTML script tag of an enqueued script.
    349349         *
    350350         * @since 4.1.0
     
    503503        if ( ! $recursion ) {
    504504            /**
    505              * Filter the list of script dependencies left to print.
     505             * Filters the list of script dependencies left to print.
    506506             *
    507507             * @since 2.3.0
  • trunk/src/wp-includes/class.wp-styles.php

    r36871 r37518  
    190190
    191191        /**
    192          * Filter the HTML link tag of an enqueued style.
     192         * Filters the HTML link tag of an enqueued style.
    193193         *
    194194         * @since 2.6.0
     
    314314        if ( ! $recursion ) {
    315315            /**
    316              * Filter the array of enqueued styles before processing for output.
     316             * Filters the array of enqueued styles before processing for output.
    317317             *
    318318             * @since 2.6.0
     
    345345
    346346        /**
    347          * Filter an enqueued style's fully-qualified URL.
     347         * Filters an enqueued style's fully-qualified URL.
    348348         *
    349349         * @since 2.6.0
  • trunk/src/wp-includes/cron.php

    r37487 r37518  
    3636    $event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
    3737    /**
    38      * Filter a single event before it is scheduled.
     38     * Filters a single event before it is scheduled.
    3939     *
    4040     * @since 3.1.0
     
    296296
    297297    /**
    298      * Filter the cron request arguments.
     298     * Filters the cron request arguments.
    299299     *
    300300     * @since 3.5.0
     
    397397    );
    398398    /**
    399      * Filter the non-default cron schedules.
     399     * Filters the non-default cron schedules.
    400400     *
    401401     * @since 2.1.0
  • trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php

    r37405 r37518  
    405405
    406406    /**
    407      * Filter the wp_get_nav_menu_items() result to supply the previewed menu items.
     407     * Filters the wp_get_nav_menu_items() result to supply the previewed menu items.
    408408     *
    409409     * @since 4.3.0
  • trunk/src/wp-includes/customize/class-wp-customize-nav-menu-setting.php

    r36622 r37518  
    236236
    237237    /**
    238      * Filter the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
     238     * Filters the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
    239239     *
    240240     * @since 4.3.0
     
    325325
    326326    /**
    327      * Filter the wp_get_nav_menu_object() result to supply the previewed menu object.
     327     * Filters the wp_get_nav_menu_object() result to supply the previewed menu object.
    328328     *
    329329     * Requesting a nav_menu object by anything but ID is not supported.
     
    376376
    377377    /**
    378      * Filter the nav_menu_options option to include this menu's auto_add preference.
     378     * Filters the nav_menu_options option to include this menu's auto_add preference.
    379379     *
    380380     * @since 4.3.0
  • trunk/src/wp-includes/date.php

    r37477 r37518  
    498498        if ( false === strpos( $column, '.' ) ) {
    499499            /**
    500              * Filter the list of valid date query columns.
     500             * Filters the list of valid date query columns.
    501501             *
    502502             * @since 3.7.0
     
    560560
    561561        /**
    562          * Filter the date query WHERE clause.
     562         * Filters the date query WHERE clause.
    563563         *
    564564         * @since 3.7.0
  • trunk/src/wp-includes/deprecated.php

    r37487 r37518  
    35393539    if ( empty( $text ) ) {
    35403540        /**
    3541          * Filter text returned for the rich text editor.
     3541         * Filters text returned for the rich text editor.
    35423542         *
    35433543         * This filter is first evaluated, and the value returned, if an empty string
     
    35843584
    35853585    /**
    3586      * Filter the text before it is formatted for the HTML editor.
     3586     * Filters the text before it is formatted for the HTML editor.
    35873587     *
    35883588     * @since 2.5.0
  • trunk/src/wp-includes/feed-rss2.php

    r35506 r37518  
    4949
    5050        /**
    51          * Filter how often to update the RSS feed.
     51         * Filters how often to update the RSS feed.
    5252         *
    5353         * @since 2.1.0
     
    6262
    6363        /**
    64          * Filter the RSS update frequency.
     64         * Filters the RSS update frequency.
    6565         *
    6666         * @since 2.1.0
  • trunk/src/wp-includes/kses.php

    r37342 r37518  
    627627    if ( is_array( $context ) ) {
    628628        /**
    629          * Filter HTML elements allowed for a given context.
     629         * Filters HTML elements allowed for a given context.
    630630         *
    631631         * @since 3.5.0
     
    680680function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) {
    681681    /**
    682      * Filter content to be run through kses.
     682     * Filters content to be run through kses.
    683683     *
    684684     * @since 2.3.0
     
    17051705
    17061706    /**
    1707      * Filter list of allowed CSS attributes.
     1707     * Filters list of allowed CSS attributes.
    17081708     *
    17091709     * @since 2.8.1
  • trunk/src/wp-includes/meta.php

    r36941 r37518  
    5353
    5454    /**
    55      * Filter whether to add metadata of a specific type.
     55     * Filters whether to add metadata of a specific type.
    5656     *
    5757     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     
    169169
    170170    /**
    171      * Filter whether to update metadata of a specific type.
     171     * Filters whether to update metadata of a specific type.
    172172     *
    173173     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     
    329329
    330330    /**
    331      * Filter whether to delete metadata of a specific type.
     331     * Filters whether to delete metadata of a specific type.
    332332     *
    333333     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     
    470470
    471471    /**
    472      * Filter whether to retrieve metadata of a specific type.
     472     * Filters whether to retrieve metadata of a specific type.
    473473     *
    474474     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     
    922922
    923923    /**
    924      * Filter whether a meta key is protected.
     924     * Filters whether a meta key is protected.
    925925     *
    926926     * @since 3.2.0
     
    946946
    947947    /**
    948      * Filter the sanitization of a specific meta key of a specific meta type.
     948     * Filters the sanitization of a specific meta key of a specific meta type.
    949949     *
    950950     * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
  • trunk/src/wp-includes/ms-blogs.php

    r37477 r37518  
    236236
    237237    /**
    238      * Filter a blog's details.
     238     * Filters a blog's details.
    239239     *
    240240     * @since MU
     
    592592
    593593    /**
    594      * Filter a blog option value.
     594     * Filters a blog option value.
    595595     *
    596596     * The dynamic portion of the hook name, `$option`, refers to the blog option name.
  • trunk/src/wp-includes/ms-load.php

    r37475 r37518  
    7272
    7373    /**
    74      * Filter checking the status of the current blog.
     74     * Filters checking the status of the current blog.
    7575     *
    7676     * @since 3.0.0
     
    169169
    170170    /**
    171      * Filter the number of path segments to consider when searching for a site.
     171     * Filters the number of path segments to consider when searching for a site.
    172172     *
    173173     * @since 3.9.0
  • trunk/src/wp-includes/nav-menu.php

    r37342 r37518  
    4040
    4141    /**
    42      * Filter the nav_menu term retrieved for wp_get_nav_menu_object().
     42     * Filters the nav_menu term retrieved for wp_get_nav_menu_object().
    4343     *
    4444     * @since 4.3.0
     
    172172
    173173    /**
    174      * Filter whether a nav menu is assigned to the specified location.
     174     * Filters whether a nav menu is assigned to the specified location.
    175175     *
    176176     * @since 4.3.0
     
    544544
    545545    /**
    546      * Filter the navigation menu objects being returned.
     546     * Filters the navigation menu objects being returned.
    547547     *
    548548     * @since 3.0.0
     
    690690
    691691    /**
    692      * Filter the navigation menu items being returned.
     692     * Filters the navigation menu items being returned.
    693693     *
    694694     * @since 3.0.0
     
    799799
    800800            /**
    801              * Filter a navigation menu item's title attribute.
     801             * Filters a navigation menu item's title attribute.
    802802             *
    803803             * @since 3.0.0
     
    809809            if ( ! isset( $menu_item->description ) ) {
    810810                /**
    811                  * Filter a navigation menu item's description.
     811                 * Filters a navigation menu item's description.
    812812                 *
    813813                 * @since 3.0.0
     
    870870
    871871    /**
    872      * Filter a navigation menu item object.
     872     * Filters a navigation menu item object.
    873873     *
    874874     * @since 3.0.0
  • trunk/src/wp-includes/rest-api.php

    r36947 r37518  
    160160function rest_get_url_prefix() {
    161161    /**
    162      * Filter the REST URL prefix.
     162     * Filters the REST URL prefix.
    163163     *
    164164     * @since 4.4.0
     
    207207
    208208    /**
    209      * Filter the REST URL.
     209     * Filters the REST URL.
    210210     *
    211211     * Use this filter to adjust the url returned by the `get_rest_url` function.
     
    270270    if ( empty( $wp_rest_server ) ) {
    271271        /**
    272          * Filter the REST Server Class.
     272         * Filters the REST Server Class.
    273273         *
    274274         * This filter allows you to adjust the server class used by the API, using a
  • trunk/src/wp-includes/revision.php

    r36659 r37518  
    3939
    4040    /**
    41      * Filter the list of fields saved in post revisions.
     41     * Filters the list of fields saved in post revisions.
    4242     *
    4343     * Included by default: 'post_title', 'post_content' and 'post_excerpt'.
     
    139139
    140140        /**
    141          * Filter whether the post has changed since the last revision.
     141         * Filters whether the post has changed since the last revision.
    142142         *
    143143         * By default a revision is saved only if one of the revisioned fields has changed.
     
    163163
    164164            /**
    165              * Filter whether a post has changed.
     165             * Filters whether a post has changed.
    166166             *
    167167             * By default a revision is saved only if one of the revisioned fields has changed.
     
    501501
    502502    /**
    503      * Filter the number of revisions to save for the given post.
     503     * Filters the number of revisions to save for the given post.
    504504     *
    505505     * Overrides the value of WP_POST_REVISIONS.
  • trunk/src/wp-includes/rewrite.php

    r37431 r37518  
    312312
    313313/**
    314  * Filter the URL base for taxonomies.
     314 * Filters the URL base for taxonomies.
    315315 *
    316316 * To remove any manually prepended /index.php/.
     
    464464
    465465    /**
    466      * Filter the URL to derive the post ID from.
     466     * Filters the URL to derive the post ID from.
    467467     *
    468468     * @since 2.2.0
  • trunk/src/wp-includes/script-loader.php

    r37472 r37518  
    139139    did_action( 'init' ) && $scripts->localize( 'heartbeat', 'heartbeatSettings',
    140140        /**
    141          * Filter the Heartbeat settings.
     141         * Filters the Heartbeat settings.
    142142         *
    143143         * @since 3.6.0
     
    153153
    154154        /**
    155          * Filter the authentication check interval.
     155         * Filters the authentication check interval.
    156156         *
    157157         * @since 3.6.0
     
    361361    did_action( 'init' ) && $scripts->localize( 'mediaelement', '_wpmejsSettings',
    362362        /**
    363          * Filter the MediaElement configuration settings.
     363         * Filters the MediaElement configuration settings.
    364364         *
    365365         * @since 4.4.0
     
    928928
    929929    /**
    930      * Filter whether to print the head scripts.
     930     * Filters whether to print the head scripts.
    931931     *
    932932     * @since 2.8.0
     
    963963
    964964    /**
    965      * Filter whether to print the footer scripts.
     965     * Filters whether to print the footer scripts.
    966966     *
    967967     * @since 2.8.0
     
    10991099
    11001100    /**
    1101      * Filter whether to print the admin styles.
     1101     * Filters whether to print the admin styles.
    11021102     *
    11031103     * @since 2.8.0
     
    11351135
    11361136    /**
    1137      * Filter whether to print the styles queued too late for the HTML head.
     1137     * Filters whether to print the styles queued too late for the HTML head.
    11381138     *
    11391139     * @since 3.3.0
  • trunk/src/wp-includes/session.php

    r36232 r37518  
    4141    final public static function get_instance( $user_id ) {
    4242        /**
    43          * Filter the session token manager used.
     43         * Filters the session token manager used.
    4444         *
    4545         * @since 4.0.0
     
    119119    final public function create( $expiration ) {
    120120        /**
    121          * Filter the information attached to the newly created session.
     121         * Filters the information attached to the newly created session.
    122122         *
    123123         * Could be used in the future to attach information such as
  • trunk/src/wp-includes/shortcodes.php

    r36097 r37518  
    538538    }
    539539    /**
    540      * Filter a shortcode's default attributes.
     540     * Filters a shortcode's default attributes.
    541541     *
    542542     * If the third parameter of the shortcode_atts() function is present then this filter is available.
  • trunk/src/wp-includes/template-loader.php

    r36876 r37518  
    1313
    1414/**
    15  * Filter whether to allow 'HEAD' requests to generate content.
     15 * Filters whether to allow 'HEAD' requests to generate content.
    1616 *
    1717 * Provides a significant performance bump by exiting before the page
     
    6666    endif;
    6767    /**
    68      * Filter the path of the current template before including it.
     68     * Filters the path of the current template before including it.
    6969     *
    7070     * @since 3.0.0
  • trunk/src/wp-includes/template.php

    r37487 r37518  
    3030
    3131    /**
    32      * Filter the path of the queried template by type.
     32     * Filters the path of the queried template by type.
    3333     *
    3434     * The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
  • trunk/src/wp-includes/theme-compat/embed-content.php

    r37452 r37518  
    3939
    4040        /**
    41          * Filter the thumbnail image size for use in the embed template.
     41         * Filters the thumbnail image size for use in the embed template.
    4242         *
    4343         * @since 4.4.0
     
    5252
    5353        /**
    54          * Filter the thumbnail shape for use in the embed template.
     54         * Filters the thumbnail shape for use in the embed template.
    5555         *
    5656         * Rectangular images are shown above the title while square images
  • trunk/src/wp-includes/update.php

    r37006 r37518  
    5656
    5757    /**
    58      * Filter the locale requested for WordPress core translations.
     58     * Filters the locale requested for WordPress core translations.
    5959     *
    6060     * @since 2.8.0
     
    266266
    267267    /**
    268      * Filter the locales requested for plugin translations.
     268     * Filters the locales requested for plugin translations.
    269269     *
    270270     * @since 3.7.0
     
    440440
    441441    /**
    442      * Filter the locales requested for theme translations.
     442     * Filters the locales requested for theme translations.
    443443     *
    444444     * @since 3.7.0
     
    580580    $update_data = array( 'counts' => $counts, 'title' => $update_title );
    581581    /**
    582      * Filter the returned array of update data for plugins, themes, and WordPress core.
     582     * Filters the returned array of update data for plugins, themes, and WordPress core.
    583583     *
    584584     * @since 3.5.0
  • trunk/src/wp-includes/vars.php

    r36813 r37518  
    6060            $is_admin = is_admin();
    6161            /**
    62              * Filter whether Google Chrome Frame should be used, if available.
     62             * Filters whether Google Chrome Frame should be used, if available.
    6363             *
    6464             * @since 3.2.0
  • trunk/src/wp-includes/widgets.php

    r37342 r37518  
    673673
    674674        /**
    675          * Filter the parameters passed to a widget's display callback.
     675         * Filters the parameters passed to a widget's display callback.
    676676         *
    677677         * Note: The filter is evaluated on both the front end and back end,
     
    756756
    757757    /**
    758      * Filter whether a sidebar has widgets.
     758     * Filters whether a sidebar has widgets.
    759759     *
    760760     * Note: The filter is also evaluated for empty sidebars, and on both the front end
     
    854854
    855855    /**
    856      * Filter whether a dynamic sidebar is considered "active".
     856     * Filters whether a dynamic sidebar is considered "active".
    857857     *
    858858     * @since 3.9.0
     
    905905
    906906    /**
    907      * Filter the list of sidebars and their widgets.
     907     * Filters the list of sidebars and their widgets.
    908908     *
    909909     * @since 2.7.0
  • trunk/src/wp-includes/wp-db.php

    r37431 r37518  
    840840
    841841        /**
    842          * Filter the list of incompatible SQL modes to exclude.
     842         * Filters the list of incompatible SQL modes to exclude.
    843843         *
    844844         * @since 3.9.0
     
    16801680
    16811681        /**
    1682          * Filter the database query.
     1682         * Filters the database query.
    16831683         *
    16841684         * Some queries are made before the plugins have been loaded,
     
    23732373
    23742374        /**
    2375          * Filter the table charset value before the DB is checked.
     2375         * Filters the table charset value before the DB is checked.
    23762376         *
    23772377         * Passing a non-null value to the filter will effectively short-circuit
     
    24772477
    24782478        /**
    2479          * Filter the column charset value before the DB is checked.
     2479         * Filters the column charset value before the DB is checked.
    24802480         *
    24812481         * Passing a non-null value to the filter will short-circuit
Note: See TracChangeset for help on using the changeset viewer.