WordPress.org

Make WordPress Core

Changeset 37498


Ignore:
Timestamp:
05/22/2016 06:25:45 PM (3 years ago)
Author:
DrewAPicture
Message:

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

See #36913.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/general-template.php

    r37487 r37498  
    204204
    205205    /**
    206      * Filter the HTML format of the search form.
     206     * Filters the HTML format of the search form.
    207207     *
    208208     * @since 3.6.0
     
    239239
    240240    /**
    241      * Filter the HTML output of the search form.
     241     * Filters the HTML output of the search form.
    242242     *
    243243     * @since 2.7.0
     
    276276    if ( $echo ) {
    277277        /**
    278          * Filter the HTML output for the Log In/Log Out link.
     278         * Filters the HTML output for the Log In/Log Out link.
    279279         *
    280280         * @since 1.5.0
     
    309309
    310310    /**
    311      * Filter the logout URL.
     311     * Filters the logout URL.
    312312     *
    313313     * @since 2.8.0
     
    338338
    339339    /**
    340      * Filter the login URL.
     340     * Filters the login URL.
    341341     *
    342342     * @since 2.8.0
     
    359359function wp_registration_url() {
    360360    /**
    361      * Filter the user registration URL.
     361     * Filters the user registration URL.
    362362     *
    363363     * @since 3.6.0
     
    420420
    421421    /**
    422      * Filter the default login form output arguments.
     422     * Filters the default login form output arguments.
    423423     *
    424424     * @since 3.0.0
     
    431431
    432432    /**
    433      * Filter content to display at the top of the login form.
     433     * Filters content to display at the top of the login form.
    434434     *
    435435     * The filter evaluates just following the opening form tag element.
     
    443443
    444444    /**
    445      * Filter content to display in the middle of the login form.
     445     * Filters content to display in the middle of the login form.
    446446     *
    447447     * The filter evaluates just following the location where the 'login-password'
     
    456456
    457457    /**
    458      * Filter content to display at the bottom of the login form.
     458     * Filters content to display at the bottom of the login form.
    459459     *
    460460     * The filter evaluates just preceding the closing form tag element.
     
    510510
    511511    /**
    512      * Filter the Lost Password URL.
     512     * Filters the Lost Password URL.
    513513     *
    514514     * @since 2.8.0
     
    546546
    547547    /**
    548      * Filter the HTML link to the Registration or Admin page.
     548     * Filters the HTML link to the Registration or Admin page.
    549549     *
    550550     * Users are sent to the admin page if logged-in, or the registration page
     
    748748        if ( $url ) {
    749749            /**
    750              * Filter the URL returned by get_bloginfo().
     750             * Filters the URL returned by get_bloginfo().
    751751             *
    752752             * @since 2.0.5
     
    758758        } else {
    759759            /**
    760              * Filter the site information returned by get_bloginfo().
     760             * Filters the site information returned by get_bloginfo().
    761761             *
    762762             * @since 0.71
     
    803803
    804804    /**
    805      * Filter the site icon URL.
     805     * Filters the site icon URL.
    806806     *
    807807     * @site 4.4.0
     
    901901
    902902    /**
    903      * Filter the custom logo output.
     903     * Filters the custom logo output.
    904904     *
    905905     * @since 4.5.0
     
    934934
    935935    /**
    936      * Filter the document title before it is generated.
     936     * Filters the document title before it is generated.
    937937     *
    938938     * Passing a non-empty value will short-circuit wp_get_document_title(),
     
    10141014
    10151015    /**
    1016      * Filter the separator for the document title.
     1016     * Filters the separator for the document title.
    10171017     *
    10181018     * @since 4.4.0
     
    10231023
    10241024    /**
    1025      * Filter the parts of the document title.
     1025     * Filters the parts of the document title.
    10261026     *
    10271027     * @since 4.4.0
     
    11801180
    11811181    /**
    1182      * Filter the parts of the page title.
     1182     * Filters the parts of the page title.
    11831183     *
    11841184     * @since 4.0.0
     
    11971197
    11981198    /**
    1199      * Filter the text of the page title.
     1199     * Filters the text of the page title.
    12001200     *
    12011201     * @since 2.0.0
     
    12381238
    12391239    /**
    1240      * Filter the page title for a single post.
     1240     * Filters the page title for a single post.
    12411241     *
    12421242     * @since 0.71
     
    12751275
    12761276    /**
    1277      * Filter the post type archive title.
     1277     * Filters the post type archive title.
    12781278     *
    12791279     * @since 3.1.0
     
    13451345    if ( is_category() ) {
    13461346        /**
    1347          * Filter the category archive page title.
     1347         * Filters the category archive page title.
    13481348         *
    13491349         * @since 2.0.10
     
    13541354    } elseif ( is_tag() ) {
    13551355        /**
    1356          * Filter the tag archive page title.
     1356         * Filters the tag archive page title.
    13571357         *
    13581358         * @since 2.3.0
     
    13631363    } elseif ( is_tax() ) {
    13641364        /**
    1365          * Filter the custom taxonomy archive page title.
     1365         * Filters the custom taxonomy archive page title.
    13661366         *
    13671367         * @since 3.1.0
     
    14931493
    14941494    /**
    1495      * Filter the archive title.
     1495     * Filters the archive title.
    14961496     *
    14971497     * @since 4.1.0
     
    15281528function get_the_archive_description() {
    15291529    /**
    1530      * Filter the archive description.
     1530     * Filters the archive description.
    15311531     *
    15321532     * @since 4.1.0
     
    15861586
    15871587    /**
    1588      * Filter the archive link content.
     1588     * Filters the archive link content.
    15891589     *
    15901590     * @since 2.6.0
     
    16751675
    16761676    /**
    1677      * Filter the SQL WHERE clause for retrieving archives.
     1677     * Filters the SQL WHERE clause for retrieving archives.
    16781678     *
    16791679     * @since 2.2.0
     
    16851685
    16861686    /**
    1687      * Filter the SQL JOIN clause for retrieving archives.
     1687     * Filters the SQL JOIN clause for retrieving archives.
    16881688     *
    16891689     * @since 2.2.0
     
    20662066    if ( $echo ) {
    20672067        /**
    2068          * Filter the HTML calendar output.
     2068         * Filters the HTML calendar output.
    20692069         *
    20702070         * @since 3.0.0
     
    21582158
    21592159        /**
    2160          * Filter the date a post was published for display.
     2160         * Filters the date a post was published for display.
    21612161         *
    21622162         * @since 0.71
     
    22032203
    22042204    /**
    2205      * Filter the date a post was published.
     2205     * Filters the date a post was published.
    22062206     *
    22072207     * @since 3.0.0
     
    22302230
    22312231    /**
    2232      * Filter the date a post was last modified for display.
     2232     * Filters the date a post was last modified for display.
    22332233     *
    22342234     * @since 2.1.0
     
    22642264
    22652265    /**
    2266      * Filter the date a post was last modified.
     2266     * Filters the date a post was last modified.
    22672267     *
    22682268     * @since 2.1.0
     
    22842284function the_time( $d = '' ) {
    22852285    /**
    2286      * Filter the time a post was written for display.
     2286     * Filters the time a post was written for display.
    22872287     *
    22882288     * @since 0.71
     
    23192319
    23202320    /**
    2321      * Filter the time a post was written.
     2321     * Filters the time a post was written.
    23222322     *
    23232323     * @since 1.5.0
     
    23592359
    23602360    /**
    2361      * Filter the localized time a post was written.
     2361     * Filters the localized time a post was written.
    23622362     *
    23632363     * @since 2.6.0
     
    23802380function the_modified_time($d = '') {
    23812381    /**
    2382      * Filter the localized time a post was last modified, for display.
     2382     * Filters the localized time a post was last modified, for display.
    23832383     *
    23842384     * @since 2.0.0
     
    24072407
    24082408    /**
    2409      * Filter the localized time a post was last modified.
     2409     * Filters the localized time a post was last modified.
    24102410     *
    24112411     * @since 2.0.0
     
    24452445
    24462446    /**
    2447      * Filter the localized time a post was last modified.
     2447     * Filters the localized time a post was last modified.
    24482448     *
    24492449     * @since 2.8.0
     
    24682468
    24692469    /**
    2470      * Filter the weekday on which the post was written, for display.
     2470     * Filters the weekday on which the post was written, for display.
    24712471     *
    24722472     * @since 0.71
     
    25032503
    25042504    /**
    2505      * Filter the localized date on which the post was written, for display.
     2505     * Filters the localized date on which the post was written, for display.
    25062506     *
    25072507     * @since 0.71
     
    25662566
    25672567    /**
    2568      * Filter whether to display the posts feed link.
     2568     * Filters whether to display the posts feed link.
    25692569     *
    25702570     * @since 4.4.0
     
    25772577
    25782578    /**
    2579      * Filter whether to display the comments feed link.
     2579     * Filters whether to display the comments feed link.
    25802580     *
    25812581     * @since 4.4.0
     
    27412741
    27422742    /**
    2743      * Filter the site icon meta tags, so Plugins can add their own.
     2743     * Filters the site icon meta tags, so Plugins can add their own.
    27442744     *
    27452745     * @since 4.3.0
     
    27882788
    27892789    /**
    2790      * Filter whether the user can access the rich (Visual) editor.
     2790     * Filters whether the user can access the rich (Visual) editor.
    27912791     *
    27922792     * @since 2.1.0
     
    28152815
    28162816    /**
    2817      * Filter which editor should be displayed by default.
     2817     * Filters which editor should be displayed by default.
    28182818     *
    28192819     * @since 2.5.0
     
    28642864function get_search_query( $escaped = true ) {
    28652865    /**
    2866      * Filter the contents of the search query variable.
     2866     * Filters the contents of the search query variable.
    28672867     *
    28682868     * @since 2.3.0
     
    28872887function the_search_query() {
    28882888    /**
    2889      * Filter the contents of the search query variable for display.
     2889     * Filters the contents of the search query variable for display.
    28902890     *
    28912891     * @since 2.3.0
     
    29232923
    29242924    /**
    2925      * Filter the language attributes for display in the html tag.
     2925     * Filters the language attributes for display in the html tag.
    29262926     *
    29272927     * @since 2.5.0
     
    31113111
    31123112        /**
    3113          * Filter the paginated links for the given archive pages.
     3113         * Filters the paginated links for the given archive pages.
    31143114         *
    31153115         * @since 3.0.0
     
    32913291
    32923292    /**
    3293      * Filter the URI of a WordPress admin CSS file.
     3293     * Filters the URI of a WordPress admin CSS file.
    32943294     *
    32953295     * @since 2.3.0
     
    33343334
    33353335    /**
    3336      * Filter the stylesheet link to the specified CSS file.
     3336     * Filters the stylesheet link to the specified CSS file.
    33373337     *
    33383338     * If the site is set to display right-to-left, the RTL stylesheet link
     
    33763376function wp_generator() {
    33773377    /**
    3378      * Filter the output of the XHTML generator tag.
     3378     * Filters the output of the XHTML generator tag.
    33793379     *
    33803380     * @since 2.5.0
     
    33973397function the_generator( $type ) {
    33983398    /**
    3399      * Filter the output of the XHTML generator tag for display.
     3399     * Filters the output of the XHTML generator tag for display.
    34003400     *
    34013401     * @since 2.5.0
     
    34723472
    34733473    /**
    3474      * Filter the HTML for the retrieved generator type.
     3474     * Filters the HTML for the retrieved generator type.
    34753475     *
    34763476     * The dynamic portion of the hook name, `$type`, refers to the generator type.
Note: See TracChangeset for help on using the changeset viewer.