WordPress.org

Make WordPress Core

Changeset 37535


Ignore:
Timestamp:
05/23/2016 04:43:20 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in root folder files to use third-person singular verbs per the inline documentation standards for PHP.

Fixes #36913.

Location:
trunk/src
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-comments-post.php

    r36424 r37535  
    4343
    4444/**
    45  * Filter the location URI to send the commenter after posting.
     45 * Filters the location URI to send the commenter after posting.
    4646 *
    4747 * @since 2.0.5
  • trunk/src/wp-links-opml.php

    r25616 r37535  
    4747foreach ( (array)$cats as $cat ) :
    4848    /**
    49      * Filter the OPML outline link category name.
     49     * Filters the OPML outline link category name.
    5050     *
    5151     * @since 2.2.0
     
    6161    foreach ( (array)$bookmarks as $bookmark ) :
    6262        /**
    63          * Filter the OPML outline link title text.
     63         * Filters the OPML outline link title text.
    6464         *
    6565         * @since 2.2.0
  • trunk/src/wp-login.php

    r37474 r37535  
    4646    $shake_error_codes = array( 'empty_password', 'empty_email', 'invalid_email', 'invalidcombo', 'empty_username', 'invalid_username', 'incorrect_password' );
    4747    /**
    48      * Filter the error codes array for shaking the login form.
     48     * Filters the error codes array for shaking the login form.
    4949     *
    5050     * @since 3.0.0
     
    107107
    108108    /**
    109      * Filter link URL of the header logo above login form.
     109     * Filters link URL of the header logo above login form.
    110110     *
    111111     * @since 2.1.0
     
    114114     */
    115115    $login_header_url = apply_filters( 'login_headerurl', $login_header_url );
    116     /**
    117      * Filter the title attribute of the header logo above login form.
     116
     117    /**
     118     * Filters the title attribute of the header logo above login form.
    118119     *
    119120     * @since 2.1.0
     
    140141
    141142    /**
    142      * Filter the login page body classes.
     143     * Filters the login page body classes.
    143144     *
    144145     * @since 3.5.0
     
    167168
    168169    /**
    169      * Filter the message to display above the login form.
     170     * Filters the message to display above the login form.
    170171     *
    171172     * @since 2.1.0
     
    197198        if ( ! empty( $errors ) ) {
    198199            /**
    199              * Filter the error messages displayed above the login form.
     200             * Filters the error messages displayed above the login form.
    200201             *
    201202             * @since 2.1.0
     
    207208        if ( ! empty( $messages ) ) {
    208209            /**
    209              * Filter instructional messages displayed above the login form.
     210             * Filters instructional messages displayed above the login form.
    210211             *
    211212             * @since 2.5.0
     
    350351
    351352    /**
    352      * Filter the subject of the password reset email.
     353     * Filters the subject of the password reset email.
    353354     *
    354355     * @since 2.8.0
     
    362363
    363364    /**
    364      * Filter the message body of the password reset mail.
     365     * Filters the message body of the password reset mail.
    365366     *
    366367     * @since 2.8.0
     
    445446
    446447    /**
    447      * Filter the life span of the post password cookie.
     448     * Filters the life span of the post password cookie.
    448449     *
    449450     * By default, the cookie expires 10 days from creation. To turn this
     
    481482
    482483    /**
    483      * Filter the log out redirect URL.
     484     * Filters the log out redirect URL.
    484485     *
    485486     * @since 4.2.0
     
    515516    $lostpassword_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
    516517    /**
    517      * Filter the URL redirected to after submitting the lostpassword/retrievepassword form.
     518     * Filters the URL redirected to after submitting the lostpassword/retrievepassword form.
    518519     *
    519520     * @since 3.0.0
     
    684685    if ( is_multisite() ) {
    685686        /**
    686          * Filter the Multisite sign up URL.
     687         * Filters the Multisite sign up URL.
    687688         *
    688689         * @since 3.0.0
     
    714715    $registration_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
    715716    /**
    716      * Filter the registration redirect URL.
     717     * Filters the registration redirect URL.
    717718     *
    718719     * @since 3.0.0
     
    805806    $requested_redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
    806807    /**
    807      * Filter the login redirect URL.
     808     * Filters the login redirect URL.
    808809     *
    809810     * @since 3.0.0
     
    872873
    873874    /**
    874      * Filter the login page errors.
     875     * Filters the login page errors.
    875876     *
    876877     * @since 3.6.0
  • trunk/src/wp-mail.php

    r34864 r37535  
    164164
    165165    /**
    166      * Filter the original content of the email.
     166     * Filters the original content of the email.
    167167     *
    168168     * Give Post-By-Email extending plugins full access to the content, either
     
    190190
    191191    /**
    192      * Filter the content of the post submitted by email before saving.
     192     * Filters the content of the post submitted by email before saving.
    193193     *
    194194     * @since 1.2.0
  • trunk/src/wp-signup.php

    r36417 r37535  
    276276
    277277    /**
    278      * Filter the default site sign-up variables.
     278     * Filters the default site sign-up variables.
    279279     *
    280280     * @since 3.0.0
     
    387387
    388388    /**
    389      * Filter the new site meta variables.
     389     * Filters the new site meta variables.
    390390     *
    391391     * @since MU
     
    397397
    398398    /**
    399      * Filter the new default site meta variables.
     399     * Filters the new default site meta variables.
    400400     *
    401401     * @since 3.0.0
     
    495495
    496496    /**
    497      * Filter the default user variables used on the user sign-up form.
     497     * Filters the default user variables used on the user sign-up form.
    498498     *
    499499     * @since 3.0.0
     
    617617
    618618    /**
    619      * Filter the default site creation variables for the site sign-up form.
     619     * Filters the default site creation variables for the site sign-up form.
    620620     *
    621621     * @since 3.0.0
     
    759759function signup_get_available_languages() {
    760760    /**
    761      * Filter the list of available languages for front-end site signups.
     761     * Filters the list of available languages for front-end site signups.
    762762     *
    763763     * Passing an empty array to this hook will disable output of the setting on the
     
    783783// Main
    784784$active_signup = get_site_option( 'registration', 'none' );
    785 /**
    786  * Filter the type of site sign-up.
     785
     786/**
     787 * Filters the type of site sign-up.
    787788 *
    788789 * @since 3.0.0
  • trunk/src/xmlrpc.php

    r34783 r37535  
    7272
    7373/**
    74  * Filter the class used for handling XML-RPC requests.
     74 * Filters the class used for handling XML-RPC requests.
    7575 *
    7676 * @since 3.1.0
Note: See TracChangeset for help on using the changeset viewer.