Changeset 37511

Timestamp:

05/22/2016 06:39:17 PM (9 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:

• trunk/src/wp-includes/ms-functions.php (modified) (24 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -375 +375 @@
 
     /**
-     * Filter whether an email address is unsafe.
+     * Filters whether an email address is unsafe.
      *
      * @since 3.5.0
@@ -498 +498 @@
 
     /**
-     * Filter the validated user registration details.
+     * Filters the validated user registration details.
      *
      * This does not allow you to override the username or email of the user during
@@ -586 +586 @@
 
     /**
-     * Filter the new site name during registration.
+     * Filters the new site name during registration.
      *
      * The name is the site's subdomain or the site's subdirectory
@@ -632 +632 @@
 
     /**
-     * Filter site details and error messages following registration.
+     * Filters site details and error messages following registration.
      *
      * @since MU
@@ -770 +770 @@
 function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_email, $key, $meta = array() ) {
     /**
-     * Filter whether to bypass the new site email notification.
+     * Filters whether to bypass the new site email notification.
      *
      * @since MU
@@ -800 +800 @@
     $message = sprintf(
         /**
-         * Filter the message content of the new blog notification email.
+         * Filters the message content of the new blog notification email.
          *
          * Content should be formatted for transmission via wp_mail().
@@ -826 +826 @@
     $subject = sprintf(
         /**
-         * Filter the subject of the new blog notification email.
+         * Filters the subject of the new blog notification email.
          *
          * @since MU
@@ -873 +873 @@
 function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) {
     /**
-     * Filter whether to bypass the email notification for new user sign-up.
+     * Filters whether to bypass the email notification for new user sign-up.
      *
      * @since MU
@@ -893 +893 @@
     $message = sprintf(
         /**
-         * Filter the content of the notification email for new user sign-up.
+         * Filters the content of the notification email for new user sign-up.
          *
          * Content should be formatted for transmission via wp_mail().
@@ -914 +914 @@
     $subject = sprintf(
         /**
-         * Filter the subject of the notification email of new user signup.
+         * Filters the subject of the notification email of new user signup.
          *
          * @since MU
@@ -1185 +1185 @@
 Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
     /**
-     * Filter the message body of the new site activation email sent
+     * Filters the message body of the new site activation email sent
      * to the network administrator.
      *
@@ -1227 +1227 @@
 
     /**
-     * Filter the message body of the new user activation email sent
+     * Filters the message body of the new user activation email sent
      * to the network administrator.
      *
@@ -1261 +1261 @@
 
     /**
-     * Filter whether a blogname is taken.
+     * Filters whether a blogname is taken.
      *
      * @since 3.5.0
@@ -1421 +1421 @@
 
     /**
-     * Filter whether to bypass the welcome email after site activation.
+     * Filters whether to bypass the welcome email after site activation.
      *
      * Returning false disables the welcome email.
@@ -1465 +1465 @@
 
     /**
-     * Filter the content of the welcome email after site activation.
+     * Filters the content of the welcome email after site activation.
      *
      * Content should be formatted for transmission via wp_mail().
@@ -1492 +1492 @@
 
     /**
-     * Filter the subject of the welcome email after site activation.
+     * Filters the subject of the welcome email after site activation.
      *
      * @since MU
@@ -1522 +1522 @@
 
     /**
-     * Filter whether to bypass the welcome email after user activation.
+     * Filters whether to bypass the welcome email after user activation.
      *
      * Returning false disables the welcome email.
@@ -1570 +1570 @@
 
     /**
-     * Filter the subject of the welcome email after user activation.
+     * Filters the subject of the welcome email after user activation.
      *
      * @since MU
@@ -1925 +1925 @@
 function maybe_redirect_404() {
     /**
-     * Filter the redirect URL for 404s on the main site.
+     * Filters the redirect URL for 404s on the main site.
      *
      * The filter is only evaluated if the NOBLOGREDIRECT constant is defined.
@@ -2210 +2210 @@
 
     /**
-     * Filter whether to update network site or user counts when a new site is created.
+     * Filters whether to update network site or user counts when a new site is created.
      *
      * @since 3.7.0
@@ -2280 +2280 @@
 function get_space_used() {
     /**
-     * Filter the amount of storage space used by the current site.
+     * Filters the amount of storage space used by the current site.
      *
      * @since 3.5.0
@@ -2312 +2312 @@
 
     /**
-     * Filter the upload quota for the current site.
+     * Filters the upload quota for the current site.
      *
      * @since 3.7.0
@@ -2388 +2388 @@
         $count = get_user_count();
         /**
-         * Filter whether the network is considered large.
+         * Filters whether the network is considered large.
          *
          * @since 3.3.0
@@ -2497 +2497 @@
 
     /**
-     * Filter reserved site names on a sub-directory Multisite install.
+     * Filters reserved site names on a sub-directory Multisite install.
      *
      * @since 3.0.0