Make WordPress Core


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

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

    r36895 r37511  
    375375
    376376        /**
    377          * Filter whether an email address is unsafe.
     377         * Filters whether an email address is unsafe.
    378378         *
    379379         * @since 3.5.0
     
    498498
    499499        /**
    500          * Filter the validated user registration details.
     500         * Filters the validated user registration details.
    501501         *
    502502         * This does not allow you to override the username or email of the user during
     
    586586
    587587        /**
    588          * Filter the new site name during registration.
     588         * Filters the new site name during registration.
    589589         *
    590590         * The name is the site's subdomain or the site's subdirectory
     
    632632
    633633        /**
    634          * Filter site details and error messages following registration.
     634         * Filters site details and error messages following registration.
    635635         *
    636636         * @since MU
     
    770770function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_email, $key, $meta = array() ) {
    771771        /**
    772          * Filter whether to bypass the new site email notification.
     772         * Filters whether to bypass the new site email notification.
    773773         *
    774774         * @since MU
     
    800800        $message = sprintf(
    801801                /**
    802                  * Filter the message content of the new blog notification email.
     802                 * Filters the message content of the new blog notification email.
    803803                 *
    804804                 * Content should be formatted for transmission via wp_mail().
     
    826826        $subject = sprintf(
    827827                /**
    828                  * Filter the subject of the new blog notification email.
     828                 * Filters the subject of the new blog notification email.
    829829                 *
    830830                 * @since MU
     
    873873function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) {
    874874        /**
    875          * Filter whether to bypass the email notification for new user sign-up.
     875         * Filters whether to bypass the email notification for new user sign-up.
    876876         *
    877877         * @since MU
     
    893893        $message = sprintf(
    894894                /**
    895                  * Filter the content of the notification email for new user sign-up.
     895                 * Filters the content of the notification email for new user sign-up.
    896896                 *
    897897                 * Content should be formatted for transmission via wp_mail().
     
    914914        $subject = sprintf(
    915915                /**
    916                  * Filter the subject of the notification email of new user signup.
     916                 * Filters the subject of the notification email of new user signup.
    917917                 *
    918918                 * @since MU
     
    11851185Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
    11861186        /**
    1187          * Filter the message body of the new site activation email sent
     1187         * Filters the message body of the new site activation email sent
    11881188         * to the network administrator.
    11891189         *
     
    12271227
    12281228        /**
    1229          * Filter the message body of the new user activation email sent
     1229         * Filters the message body of the new user activation email sent
    12301230         * to the network administrator.
    12311231         *
     
    12611261
    12621262        /**
    1263          * Filter whether a blogname is taken.
     1263         * Filters whether a blogname is taken.
    12641264         *
    12651265         * @since 3.5.0
     
    14211421
    14221422        /**
    1423          * Filter whether to bypass the welcome email after site activation.
     1423         * Filters whether to bypass the welcome email after site activation.
    14241424         *
    14251425         * Returning false disables the welcome email.
     
    14651465
    14661466        /**
    1467          * Filter the content of the welcome email after site activation.
     1467         * Filters the content of the welcome email after site activation.
    14681468         *
    14691469         * Content should be formatted for transmission via wp_mail().
     
    14921492
    14931493        /**
    1494          * Filter the subject of the welcome email after site activation.
     1494         * Filters the subject of the welcome email after site activation.
    14951495         *
    14961496         * @since MU
     
    15221522
    15231523        /**
    1524          * Filter whether to bypass the welcome email after user activation.
     1524         * Filters whether to bypass the welcome email after user activation.
    15251525         *
    15261526         * Returning false disables the welcome email.
     
    15701570
    15711571        /**
    1572          * Filter the subject of the welcome email after user activation.
     1572         * Filters the subject of the welcome email after user activation.
    15731573         *
    15741574         * @since MU
     
    19251925function maybe_redirect_404() {
    19261926        /**
    1927          * Filter the redirect URL for 404s on the main site.
     1927         * Filters the redirect URL for 404s on the main site.
    19281928         *
    19291929         * The filter is only evaluated if the NOBLOGREDIRECT constant is defined.
     
    22102210
    22112211        /**
    2212          * Filter whether to update network site or user counts when a new site is created.
     2212         * Filters whether to update network site or user counts when a new site is created.
    22132213         *
    22142214         * @since 3.7.0
     
    22802280function get_space_used() {
    22812281        /**
    2282          * Filter the amount of storage space used by the current site.
     2282         * Filters the amount of storage space used by the current site.
    22832283         *
    22842284         * @since 3.5.0
     
    23122312
    23132313        /**
    2314          * Filter the upload quota for the current site.
     2314         * Filters the upload quota for the current site.
    23152315         *
    23162316         * @since 3.7.0
     
    23882388                $count = get_user_count();
    23892389                /**
    2390                  * Filter whether the network is considered large.
     2390                 * Filters whether the network is considered large.
    23912391                 *
    23922392                 * @since 3.3.0
     
    24972497
    24982498        /**
    2499          * Filter reserved site names on a sub-directory Multisite install.
     2499         * Filters reserved site names on a sub-directory Multisite install.
    25002500         *
    25012501         * @since 3.0.0
Note: See TracChangeset for help on using the changeset viewer.