Changeset 47122 for trunk/src/wp-includes/user.php

Timestamp:

01/29/2020 12:43:23 AM (6 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-includes/user.php (modified) (20 diffs)

trunk/src/wp-includes/user.php

@@ -88 +88 @@
     $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
 
-    global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie
+    global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie().
     $auth_secure_cookie = $secure_cookie;
 
@@ -209 +209 @@
 
         if ( empty( $email ) ) {
-            $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) ); // Uses 'empty_username' for back-compat with wp_signon()
+            // Uses 'empty_username' for back-compat with wp_signon().
+            $error->add( 'empty_username', __( '<strong>ERROR</strong>: The email field is empty.' ) );
         }
 
@@ -427 +428 @@
 
 //
-// User option functions
+// User option functions.
 //
 
@@ -481 +482 @@
 
     $prefix = $wpdb->get_blog_prefix();
-    if ( $user->has_prop( $prefix . $option ) ) { // Blog specific
+    if ( $user->has_prop( $prefix . $option ) ) { // Blog-specific.
         $result = $user->get( $prefix . $option );
-    } elseif ( $user->has_prop( $option ) ) { // User specific and cross-blog
+    } elseif ( $user->has_prop( $option ) ) { // User-specific and cross-blog.
         $result = $user->get( $option );
     } else {
@@ -600 +601 @@
     $user_id = (int) $user_id;
 
-    // Logged out users can't have sites
+    // Logged out users can't have sites.
     if ( empty( $user_id ) ) {
         return array();
@@ -734 +735 @@
     }
 
-    // Technically not needed, but does save calls to get_site and get_user_meta
-    // in the event that the function is called when a user isn't logged in
+    // Technically not needed, but does save calls to get_site() and get_user_meta()
+    // in the event that the function is called when a user isn't logged in.
     if ( empty( $user_id ) ) {
         return false;
@@ -764 +765 @@
     }
 
-    // no underscore before capabilities in $base_capabilities_key
+    // No underscore before capabilities in $base_capabilities_key.
     $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
     $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
@@ -876 +877 @@
     global $wpdb;
 
-    // Initialize
+    // Initialize.
     if ( ! $site_id ) {
         $site_id = get_current_blog_id();
@@ -985 +986 @@
 
 //
-// Private helper functions
+// Private helper functions.
 //
 
@@ -1541 +1542 @@
         }
 
-        // hashed in wp_update_user(), plaintext if called directly
+        // hashed in wp_update_user(), plaintext if called directly.
         $user_pass = ! empty( $userdata['user_pass'] ) ? $userdata['user_pass'] : $old_user_data->user_pass;
     } else {
         $update = false;
-        // Hash the password
+        // Hash the password.
         $user_pass = wp_hash_password( $userdata['user_pass'] );
     }
@@ -1562 +1563 @@
     $pre_user_login = apply_filters( 'pre_user_login', $sanitized_user_login );
 
-    //Remove any non-printable chars from the login string to see if we have ended up with an empty username
+    // Remove any non-printable chars from the login string to see if we have ended up with an empty username.
     $user_login = trim( $pre_user_login );
 
@@ -1934 +1935 @@
     }
 
-    // First, get all of the original fields
+    // First, get all of the original fields.
     $user_obj = get_userdata( $ID );
     if ( ! $user_obj ) {
@@ -1942 +1943 @@
     $user = $user_obj->to_array();
 
-    // Add additional custom fields
+    // Add additional custom fields.
     foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
         $user[ $key ] = get_user_meta( $ID, $key, true );
@@ -1951 +1952 @@
 
     if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
-        // If password is changing, hash it now
+        // If password is changing, hash it now.
         $plaintext_pass        = $userdata['user_pass'];
         $userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
@@ -2412 +2413 @@
         return $user;
     } elseif ( $hash_is_correct && $expiration_time ) {
-        // Key has an expiration time that's passed
+        // Key has an expiration time that's passed.
         return new WP_Error( 'expired_key', __( 'Invalid key.' ) );
     }
@@ -2492 +2493 @@
     $user_email = apply_filters( 'user_registration_email', $user_email );
 
-    // Check the username
+    // Check the username.
     if ( $sanitized_user_login == '' ) {
         $errors->add( 'empty_username', __( '<strong>ERROR</strong>: Please enter a username.' ) );
@@ -2509 +2510 @@
     }
 
-    // Check the email address
+    // Check the email address.
     if ( $user_email == '' ) {
         $errors->add( 'empty_email', __( '<strong>ERROR</strong>: Please type your email address.' ) );
@@ -2568 +2569 @@
     }
 
-    update_user_option( $user_id, 'default_password_nag', true, true ); //Set up the Password change nag.
+    update_user_option( $user_id, 'default_password_nag', true, true ); // Set up the password change nag.
 
     /**
@@ -2729 +2730 @@
         }
 
-        // Upgrade stdClass to WP_User
+        // Upgrade stdClass to WP_User.
         if ( is_object( $current_user ) && isset( $current_user->ID ) ) {
             $cur_id       = $current_user->ID;
@@ -3406 +3407 @@
         array(
             'post_type'     => 'user_request',
-            'post_name__in' => array( $action_name ),  // Action name stored in post_name column.
-            'title'         => $email_address, // Email address stored in post_title column.
+            'post_name__in' => array( $action_name ), // Action name stored in post_name column.
+            'title'         => $email_address,        // Email address stored in post_title column.
             'post_status'   => array(
                 'request-pending',