WordPress.org
Get WordPress

Make WordPress Core


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

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

    r37315 r37508  
    175175
    176176        /**
    177          * Filter the wp_mail() arguments.
     177         * Filters the wp_mail() arguments.
    178178         *
    179179         * @since 2.2.0
    … …  
    330330
    331331        /**
    332          * Filter the email address to send from.
     332         * Filters the email address to send from.
    333333         *
    334334         * @since 2.2.0
    … …  
    339339
    340340        /**
    341          * Filter the name to associate with the "from" email address.
     341         * Filters the name to associate with the "from" email address.
    342342         *
    343343         * @since 2.3.0
    … …  
    417417
    418418        /**
    419          * Filter the wp_mail() content type.
     419         * Filters the wp_mail() content type.
    420420         *
    421421         * @since 2.3.0
    … …  
    438438
    439439        /**
    440          * Filter the default wp_mail() charset.
     440         * Filters the default wp_mail() charset.
    441441         *
    442442         * @since 2.3.0
    … …  
    514514
    515515        /**
    516          * Filter whether a set of user login credentials are valid.
     516         * Filters whether a set of user login credentials are valid.
    517517         *
    518518         * A WP_User object is returned if the credentials authenticate a user.
    … …  
    721721
    722722        /**
    723          * Filter the authentication cookie.
     723         * Filters the authentication cookie.
    724724         *
    725725         * @since 2.5.0
    … …  
    803803        if ( $remember ) {
    804804                /**
    805                  * Filter the duration of the authentication cookie expiration period.
     805                 * Filters the duration of the authentication cookie expiration period.
    806806                 *
    807807                 * @since 2.8.0
    … …  
    832832
    833833        /**
    834          * Filter whether the connection is secure.
     834         * Filters whether the connection is secure.
    835835         *
    836836         * @since 3.1.0
    … …  
    842842
    843843        /**
    844          * Filter whether to use a secure cookie when logged-in.
     844         * Filters whether to use a secure cookie when logged-in.
    845845         *
    846846         * @since 3.1.0
    … …  
    968968
    969969        /**
    970          * Filter whether to use a secure authentication redirect.
     970         * Filters whether to use a secure authentication redirect.
    971971         *
    972972         * @since 3.1.0
    … …  
    991991        } else {
    992992                /**
    993                  * Filter the authentication redirect scheme.
     993                 * Filters the authentication redirect scheme.
    994994                 *
    995995                 * @since 2.9.0
    … …  
    11441144
    11451145        /**
    1146          * Filter the redirect location.
     1146         * Filters the redirect location.
    11471147         *
    11481148         * @since 2.1.0
    … …  
    11541154
    11551155        /**
    1156          * Filter the redirect status code.
     1156         * Filters the redirect status code.
    11571157         *
    11581158         * @since 2.3.0
    … …  
    12481248
    12491249        /**
    1250          * Filter the redirect fallback URL for when the provided redirect is not safe (local).
     1250         * Filters the redirect fallback URL for when the provided redirect is not safe (local).
    12511251         *
    12521252         * @since 4.3.0
    … …  
    13121312
    13131313        /**
    1314          * Filter the whitelist of hosts to redirect to.
     1314         * Filters the whitelist of hosts to redirect to.
    13151315         *
    13161316         * @since 2.3.0
    … …  
    13571357
    13581358        /**
    1359          * Filter the list of email addresses to receive a comment notification.
     1359         * Filters the list of email addresses to receive a comment notification.
    13601360         *
    13611361         * By default, only post authors are notified of comments. This filter allows
    … …  
    13791379
    13801380        /**
    1381          * Filter whether to notify comment authors of their comments on their own posts.
     1381         * Filters whether to notify comment authors of their comments on their own posts.
    13821382         *
    13831383         * By default, comment authors aren't notified of their comments on their own
    … …  
    14851485
    14861486        /**
    1487          * Filter the comment notification email text.
     1487         * Filters the comment notification email text.
    14881488         *
    14891489         * @since 1.5.2
    … …  
    14951495
    14961496        /**
    1497          * Filter the comment notification email subject.
     1497         * Filters the comment notification email subject.
    14981498         *
    14991499         * @since 1.5.2
    … …  
    15051505
    15061506        /**
    1507          * Filter the comment notification email headers.
     1507         * Filters the comment notification email headers.
    15081508         *
    15091509         * @since 1.5.2
    … …  
    15421542
    15431543        /**
    1544          * Filter whether to send the site moderator email notifications, overriding the site setting.
     1544         * Filters whether to send the site moderator email notifications, overriding the site setting.
    15451545         *
    15461546         * @since 4.4.0
    … …  
    16171617
    16181618        /**
    1619          * Filter the list of recipients for comment moderation emails.
     1619         * Filters the list of recipients for comment moderation emails.
    16201620         *
    16211621         * @since 3.7.0
    … …  
    16271627
    16281628        /**
    1629          * Filter the comment moderation email text.
     1629         * Filters the comment moderation email text.
    16301630         *
    16311631         * @since 1.5.2
    … …  
    16371637
    16381638        /**
    1639          * Filter the comment moderation email subject.
     1639         * Filters the comment moderation email subject.
    16401640         *
    16411641         * @since 1.5.2
    … …  
    16471647
    16481648        /**
    1649          * Filter the comment moderation email headers.
     1649         * Filters the comment moderation email headers.
    16501650         *
    16511651         * @since 2.8.0
    … …  
    17661766function wp_nonce_tick() {
    17671767        /**
    1768          * Filter the lifespan of nonces in seconds.
     1768         * Filters the lifespan of nonces in seconds.
    17691769         *
    17701770         * @since 2.5.0
    … …  
    17981798        if ( ! $uid ) {
    17991799                /**
    1800                  * Filter whether the user who generated the nonce is logged out.
     1800                 * Filters whether the user who generated the nonce is logged out.
    18011801                 *
    18021802                 * @since 3.5.0
    … …  
    19101910        if ( isset( $cached_salts[ $scheme ] ) ) {
    19111911                /**
    1912                  * Filter the WordPress salt.
     1912                 * Filters the WordPress salt.
    19131913                 *
    19141914                 * @since 2.5.0
    … …  
    20572057
    20582058                /**
    2059                  * Filter whether the plaintext password matches the encrypted password.
     2059                 * Filters whether the plaintext password matches the encrypted password.
    20602060                 *
    20612061                 * @since 2.5.0
    … …  
    21102110
    21112111        /**
    2112          * Filter the randomly-generated password.
     2112         * Filters the randomly-generated password.
    21132113         *
    21142114         * @since 3.0.0
    … …  
    22992299
    23002300        /**
    2301          * Filter whether to retrieve the avatar URL early.
     2301         * Filters whether to retrieve the avatar URL early.
    23022302         *
    23032303         * Passing a non-null value will effectively short-circuit get_avatar(), passing
    … …  
    23582358
    23592359        /**
    2360          * Filter the avatar to retrieve.
     2360         * Filters the avatar to retrieve.
    23612361         *
    23622362         * @since 2.5.0
Note: See TracChangeset for help on using the changeset viewer.