Changeset 37535 for trunk/src/wp-login.php

Timestamp:

05/23/2016 04:43:20 PM (9 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.

File:

• trunk/src/wp-login.php (modified) (16 diffs)

trunk/src/wp-login.php

@@ -46 +46 @@
     $shake_error_codes = array( 'empty_password', 'empty_email', 'invalid_email', 'invalidcombo', 'empty_username', 'invalid_username', 'incorrect_password' );
     /**
-     * Filter the error codes array for shaking the login form.
+     * Filters the error codes array for shaking the login form.
      *
      * @since 3.0.0
@@ -107 +107 @@
 
     /**
-     * Filter link URL of the header logo above login form.
+     * Filters link URL of the header logo above login form.
      *
      * @since 2.1.0
@@ -114 +114 @@
      */
     $login_header_url = apply_filters( 'login_headerurl', $login_header_url );
-    /**
-     * Filter the title attribute of the header logo above login form.
+
+    /**
+     * Filters the title attribute of the header logo above login form.
      *
      * @since 2.1.0
@@ -140 +141 @@
 
     /**
-     * Filter the login page body classes.
+     * Filters the login page body classes.
      *
      * @since 3.5.0
@@ -167 +168 @@
 
     /**
-     * Filter the message to display above the login form.
+     * Filters the message to display above the login form.
      *
      * @since 2.1.0
@@ -197 +198 @@
         if ( ! empty( $errors ) ) {
             /**
-             * Filter the error messages displayed above the login form.
+             * Filters the error messages displayed above the login form.
              *
              * @since 2.1.0
@@ -207 +208 @@
         if ( ! empty( $messages ) ) {
             /**
-             * Filter instructional messages displayed above the login form.
+             * Filters instructional messages displayed above the login form.
              *
              * @since 2.5.0
@@ -350 +351 @@
 
     /**
-     * Filter the subject of the password reset email.
+     * Filters the subject of the password reset email.
      *
      * @since 2.8.0
@@ -362 +363 @@
 
     /**
-     * Filter the message body of the password reset mail.
+     * Filters the message body of the password reset mail.
      *
      * @since 2.8.0
@@ -445 +446 @@
 
     /**
-     * Filter the life span of the post password cookie.
+     * Filters the life span of the post password cookie.
      *
      * By default, the cookie expires 10 days from creation. To turn this
@@ -481 +482 @@
 
     /**
-     * Filter the log out redirect URL.
+     * Filters the log out redirect URL.
      *
      * @since 4.2.0
@@ -515 +516 @@
     $lostpassword_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
     /**
-     * Filter the URL redirected to after submitting the lostpassword/retrievepassword form.
+     * Filters the URL redirected to after submitting the lostpassword/retrievepassword form.
      *
      * @since 3.0.0
@@ -684 +685 @@
     if ( is_multisite() ) {
         /**
-         * Filter the Multisite sign up URL.
+         * Filters the Multisite sign up URL.
          *
          * @since 3.0.0
@@ -714 +715 @@
     $registration_redirect = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
     /**
-     * Filter the registration redirect URL.
+     * Filters the registration redirect URL.
      *
      * @since 3.0.0
@@ -805 +806 @@
     $requested_redirect_to = isset( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
     /**
-     * Filter the login redirect URL.
+     * Filters the login redirect URL.
      *
      * @since 3.0.0
@@ -872 +873 @@
 
     /**
-     * Filter the login page errors.
+     * Filters the login page errors.
      *
      * @since 3.6.0