Make WordPress Core

Changeset 37503


Ignore:
Timestamp:
05/22/2016 06:29:11 PM (10 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in wp-includes/user.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/user.php

    r37342 r37503  
    6060
    6161        /**
    62          * Filter whether to use a secure sign-on cookie.
     62         * Filters whether to use a secure sign-on cookie.
    6363         *
    6464         * @since 3.1.0
     
    146146
    147147        /**
    148          * Filter whether the given user can be authenticated with the provided $password.
     148         * Filters whether the given user can be authenticated with the provided $password.
    149149         *
    150150         * @since 2.5.0
     
    296296        if ( $user instanceof WP_User && is_multisite() ) {
    297297                /**
    298                  * Filter whether the user has been marked as a spammer.
     298                 * Filters whether the user has been marked as a spammer.
    299299                 *
    300300                 * @since 3.7.0
     
    361361
    362362        /**
    363          * Filter the number of posts a user has written.
     363         * Filters the number of posts a user has written.
    364364         *
    365365         * @since 2.7.0
     
    468468
    469469        /**
    470          * Filter a specific user option value.
     470         * Filters a specific user option value.
    471471         *
    472472         * The dynamic portion of the hook name, `$option`, refers to the user option name.
     
    580580
    581581        /**
    582          * Filter the list of a user's sites before it is populated.
     582         * Filters the list of a user's sites before it is populated.
    583583         *
    584584         * Passing a non-null value to the filter will effectively short circuit
     
    668668
    669669        /**
    670          * Filter the list of blogs a user belongs to.
     670         * Filters the list of blogs a user belongs to.
    671671         *
    672672         * @since MU
     
    10411041
    10421042        /**
    1043          * Filter the query arguments for the user drop-down.
     1043         * Filters the query arguments for the user drop-down.
    10441044         *
    10451045         * @since 4.4.0
     
    11041104
    11051105        /**
    1106          * Filter the wp_dropdown_users() HTML output.
     1106         * Filters the wp_dropdown_users() HTML output.
    11071107         *
    11081108         * @since 2.3.0
     
    11551155
    11561156                        /**
    1157                          * Filter a user field value in the 'edit' context.
     1157                         * Filters a user field value in the 'edit' context.
    11581158                         *
    11591159                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
     
    11791179
    11801180                        /**
    1181                          * Filter the value of a user field in the 'db' context.
     1181                         * Filters the value of a user field in the 'db' context.
    11821182                         *
    11831183                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
     
    11991199
    12001200                        /**
    1201                          * Filter the value of a user field in a standard context.
     1201                         * Filters the value of a user field in a standard context.
    12021202                         *
    12031203                         * The dynamic portion of the hook name, `$field`, refers to the prefixed user
     
    13231323
    13241324        /**
    1325          * Filter whether the provided username is valid or not.
     1325         * Filters whether the provided username is valid or not.
    13261326         *
    13271327         * @since 2.0.1
     
    14131413
    14141414        /**
    1415          * Filter a username after it has been sanitized.
     1415         * Filters a username after it has been sanitized.
    14161416         *
    14171417         * This filter is called before the user is created or updated.
     
    14381438
    14391439        /**
    1440          * Filter the list of blacklisted usernames.
     1440         * Filters the list of blacklisted usernames.
    14411441         *
    14421442         * @since 4.4.0
     
    14691469
    14701470        /**
    1471          * Filter a user's nicename before the user is created or updated.
     1471         * Filters a user's nicename before the user is created or updated.
    14721472         *
    14731473         * @since 2.0.3
     
    14801480
    14811481        /**
    1482          * Filter a user's URL before the user is created or updated.
     1482         * Filters a user's URL before the user is created or updated.
    14831483         *
    14841484         * @since 2.0.3
     
    14911491
    14921492        /**
    1493          * Filter a user's email before the user is created or updated.
     1493         * Filters a user's email before the user is created or updated.
    14941494         *
    14951495         * @since 2.0.3
     
    15131513
    15141514        /**
    1515          * Filter a user's nickname before the user is created or updated.
     1515         * Filters a user's nickname before the user is created or updated.
    15161516         *
    15171517         * @since 2.0.3
     
    15241524
    15251525        /**
    1526          * Filter a user's first name before the user is created or updated.
     1526         * Filters a user's first name before the user is created or updated.
    15271527         *
    15281528         * @since 2.0.3
     
    15351535
    15361536        /**
    1537          * Filter a user's last name before the user is created or updated.
     1537         * Filters a user's last name before the user is created or updated.
    15381538         *
    15391539         * @since 2.0.3
     
    15611561
    15621562        /**
    1563          * Filter a user's display name before the user is created or updated.
     1563         * Filters a user's display name before the user is created or updated.
    15641564         *
    15651565         * @since 2.0.3
     
    15721572
    15731573        /**
    1574          * Filter a user's description before the user is created or updated.
     1574         * Filters a user's description before the user is created or updated.
    15751575         *
    15761576         * @since 2.0.3
     
    16241624
    16251625        /**
    1626          * Filter a user's meta values and keys before the user is created or updated.
     1626         * Filters a user's meta values and keys before the user is created or updated.
    16271627         *
    16281628         * Does not include contact methods. These are added using `wp_get_user_contact_methods( $user )`.
     
    17431743
    17441744                /**
    1745                  * Filter whether to send the password change email.
     1745                 * Filters whether to send the password change email.
    17461746                 *
    17471747                 * @since 4.3.0
     
    17591759        if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
    17601760                /**
    1761                  * Filter whether to send the email change email.
     1761                 * Filters whether to send the email change email.
    17621762                 *
    17631763                 * @since 4.3.0
     
    18081808
    18091809                        /**
    1810                          * Filter the contents of the email sent when the user's password is changed.
     1810                         * Filters the contents of the email sent when the user's password is changed.
    18111811                         *
    18121812                         * @since 4.3.0
     
    18631863
    18641864                        /**
    1865                          * Filter the contents of the email sent when the user's email is changed.
     1865                         * Filters the contents of the email sent when the user's email is changed.
    18661866                         *
    18671867                         * @since 4.3.0
     
    19771977
    19781978        /**
    1979          * Filter the user contact methods.
     1979         * Filters the user contact methods.
    19801980         *
    19811981         * @since 2.9.0
     
    20132013
    20142014        /**
    2015          * Filter the text describing the site's password complexity policy.
     2015         * Filters the text describing the site's password complexity policy.
    20162016         *
    20172017         * @since 4.1.0
     
    20622062
    20632063        /**
    2064          * Filter whether to allow a password to be reset.
     2064         * Filters whether to allow a password to be reset.
    20652065         *
    20662066         * @since 2.7.0
     
    21422142
    21432143        /**
    2144          * Filter the expiration time of password reset keys.
     2144         * Filters the expiration time of password reset keys.
    21452145         *
    21462146         * @since 4.3.0
     
    21762176
    21772177                /**
    2178                  * Filter the return value of check_password_reset_key() when an
     2178                 * Filters the return value of check_password_reset_key() when an
    21792179                 * old-style key is used.
    21802180                 *
     
    22392239        $sanitized_user_login = sanitize_user( $user_login );
    22402240        /**
    2241          * Filter the email address of a user being registered.
     2241         * Filters the email address of a user being registered.
    22422242         *
    22432243         * @since 2.1.0
     
    22882288
    22892289        /**
    2290          * Filter the errors encountered when a new user is being registered.
     2290         * Filters the errors encountered when a new user is being registered.
    22912291         *
    22922292         * The filtered WP_Error object may, for example, contain errors for an invalid
     
    24802480
    24812481        /**
    2482          * Filter the current user.
     2482         * Filters the current user.
    24832483         *
    24842484         * The default filters use this to determine the current user from the
Note: See TracChangeset for help on using the changeset viewer.