Changeset 43644

Timestamp:

09/14/2018 01:47:01 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Improve docblocks within wp-login.php.

Props birgire

See #42505

File:

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

trunk/src/wp-login.php

@@ -12 +12 @@
 require( dirname( __FILE__ ) . '/wp-load.php' );
 
-// Redirect to https login if forced to use SSL
+// Redirect to HTTPS login if forced to use SSL.
 if ( force_ssl_admin() && ! is_ssl() ) {
     if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
@@ -25 +25 @@
 /**
  * Output the login page header.
+ *
+ * @since 2.1.0
  *
  * @param string   $title    Optional. WordPress login Page title to display in the `<title>` element.
@@ -90 +92 @@
      * Remove all stored post data on logging out.
      * This could be added by add_action('login_head'...) like wp_shake_js(),
-     * but maybe better if it's not removable by plugins
+     * but maybe better if it's not removable by plugins.
      */
     if ( 'loggedout' == $wp_error->get_error_code() ) {
@@ -203 +205 @@
     }
 
-    // In case a plugin uses $error rather than the $wp_errors object
+    // In case a plugin uses $error rather than the $wp_errors object.
     if ( ! empty( $error ) ) {
         $wp_error->add( 'error', $error );
@@ -248 +250 @@
  * Outputs the footer for the login page.
  *
- * @param string $input_id Which input to auto-focus
+ * @since 3.1.0
+ *
+ * @param string $input_id Which input to auto-focus.
  */
 function login_footer( $input_id = '' ) {
@@ -289 +293 @@
 
 /**
+ * Outputs the Javascript to handle the form shaking.
+ *
  * @since 3.0.0
  */
@@ -304 +310 @@
 
 /**
+ * Outputs the viewport meta tag.
+ *
  * @since 3.7.0
  */
@@ -314 +322 @@
 /**
  * Handles sending password retrieval email to user.
+ *
+ * @since 2.5.0
  *
  * @return bool|WP_Error True: when finish. WP_Error on error
@@ -418 +428 @@
 
 //
-// Main
+// Main.
 //
 
@@ -428 +438 @@
 }
 
-// validate action so as to default to the login screen
+// Validate action so as to default to the login screen.
 if ( ! in_array( $action, array( 'postpass', 'logout', 'lostpassword', 'retrievepassword', 'resetpass', 'rp', 'register', 'login', 'confirmaction' ), true ) && false === has_filter( 'login_form_' . $action ) ) {
     $action = 'login';
@@ -891 +901 @@
          * redirects or exits first.
          *
+         * @since 4.9.6
+         *
          * @param int $request_id Request ID.
          */
@@ -909 +921 @@
         }
 
-        // If the user wants ssl but the session is not ssl, force a secure cookie.
+        // If the user wants SSL but the session is not SSL, force a secure cookie.
         if ( ! empty( $_POST['log'] ) && ! force_ssl_admin() ) {
             $user_name = sanitize_user( $_POST['log'] );
@@ -928 +940 @@
         if ( isset( $_REQUEST['redirect_to'] ) ) {
             $redirect_to = $_REQUEST['redirect_to'];
-            // Redirect to https if user wants ssl
+            // Redirect to HTTPS if user wants SSL.
             if ( $secure_cookie && false !== strpos( $redirect_to, 'wp-admin' ) ) {
                 $redirect_to = preg_replace( '|^http://|', 'https://', $redirect_to );
@@ -1023 +1035 @@
             }
         } else {
-            // Some parts of this script use the main login form to display a message
+            // Some parts of this script use the main login form to display a message.
             if ( isset( $_GET['loggedout'] ) && true == $_GET['loggedout'] ) {
                 $errors->add( 'loggedout', __( 'You are now logged out.' ), 'message' );
@@ -1173 +1185 @@
 
         break;
-} // end action switch
+} // End action switch.