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

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

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

trunk/src/wp-login.php

@@ -42 +42 @@
     global $error, $interim_login, $action;
 
-    // Don't index any of these forms
+    // Don't index any of these forms.
     add_action( 'login_head', 'wp_sensitive_page_meta' );
 
@@ -269 +269 @@
         }
     }
-} // End of login_header()
+} // End of login_header().
 
 /**
@@ -301 +301 @@
 
     ?>
-    </div><?php // End of <div id="login"> ?>
+    </div><?php // End of <div id="login">. ?>
 
     <?php
@@ -508 +508 @@
 header( 'Content-Type: ' . get_bloginfo( 'html_type' ) . '; charset=' . get_bloginfo( 'charset' ) );
 
-if ( defined( 'RELOCATE' ) && RELOCATE ) { // Move flag is set
+if ( defined( 'RELOCATE' ) && RELOCATE ) { // Move flag is set.
     if ( isset( $_SERVER['PATH_INFO'] ) && ( $_SERVER['PATH_INFO'] !== $_SERVER['PHP_SELF'] ) ) {
         $_SERVER['PHP_SELF'] = str_replace( $_SERVER['PATH_INFO'], '', $_SERVER['PHP_SELF'] );
@@ -520 +520 @@
 }
 
-//Set a cookie now to see if they are supported by the browser.
+// Set a cookie now to see if they are supported by the browser.
 $secure = ( 'https' === parse_url( wp_login_url(), PHP_URL_SCHEME ) );
 setcookie( TEST_COOKIE, 'WP Cookie check', 0, COOKIEPATH, COOKIE_DOMAIN, $secure );
@@ -561 +561 @@
 
     case 'confirm_admin_email':
-        // Note that `is_user_logged_in()` will return false immediately after logging in
-        // as the current user is not set, see wp-includes/pluggable.php.
-        // However this action runs on a redirect after logging in.
+        /*
+         * Note that `is_user_logged_in()` will return false immediately after logging in
+         * as the current user is not set, see wp-includes/pluggable.php.
+         * However this action runs on a redirect after logging in.
+         */
         if ( ! is_user_logged_in() ) {
             wp_safe_redirect( wp_login_url() );
@@ -1211 +1213 @@
                 );
             } elseif ( isset( $_POST['testcookie'] ) && empty( $_COOKIE[ TEST_COOKIE ] ) ) {
-                // If cookies are disabled we can't log in even with a valid user+pass
+                // If cookies are disabled, we can't log in even with a valid user and password.
                 $user = new WP_Error(
                     'test_cookie',