Changeset 58341 for trunk

Timestamp:

06/05/2024 12:21:46 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Login and Registration: Declare globals at the top of wp_signon() for consistency.

Follow-up to [10437], [32637], [58333].

See #58901.

Location:

trunk

Files:

• src/wp-includes/user.php (modified) (8 diffs)
• tests/phpunit/tests/auth.php (modified) (2 diffs)

trunk/src/wp-includes/user.php

@@ -26 +26 @@
  *
  * @global string $auth_secure_cookie
+ * @global wpdb   $wpdb               WordPress database abstraction object.
  *
  * @param array       $credentials {
@@ -39 +40 @@
  */
 function wp_signon( $credentials = array(), $secure_cookie = '' ) {
+        global $auth_secure_cookie, $wpdb;
+
         if ( empty( $credentials ) ) {
                 $credentials = array(
@@ -99 +102 @@
         $secure_cookie = apply_filters( 'secure_signon_cookie', $secure_cookie, $credentials );
 
-        global $auth_secure_cookie; // XXX ugly hack to pass this to wp_authenticate_cookie().
+        // XXX ugly hack to pass this to wp_authenticate_cookie().
         $auth_secure_cookie = $secure_cookie;
 
@@ -112 +115 @@
         wp_set_auth_cookie( $user->ID, $credentials['remember'], $secure_cookie );
 
-        /**
-         * @global wpdb $wpdb WordPress database abstraction object.
-         */
-        global $wpdb;
-
-        // Flush `user_activation_key` if exists after successful login.
+        // Clear `user_activation_key` after a successful login.
         if ( ! empty( $user->user_activation_key ) ) {
                 $wpdb->update(
@@ -124 +122 @@
                                 'user_activation_key' => '',
                         ),
-                        array( 'ID' => $user->ID ),
-                        array( '%s' ),
-                        array( '%d' )
+                        array( 'ID' => $user->ID )
                 );
 
-                // Empty user_activation_key object.
                 $user->user_activation_key = '';
         }
@@ -142 +137 @@
          */
         do_action( 'wp_login', $user->user_login, $user );
+
         return $user;
 }
@@ -307 +303 @@
  */
 function wp_authenticate_cookie( $user, $username, $password ) {
+        global $auth_secure_cookie;
+
         if ( $user instanceof WP_User ) {
                 return $user;
@@ -316 +314 @@
                         return new WP_User( $user_id );
                 }
-
-                global $auth_secure_cookie;
 
                 if ( $auth_secure_cookie ) {

trunk/tests/phpunit/tests/auth.php

@@ -425 +425 @@
 
         /**
-         * Ensure that the user_activation_key is cleared (if available) after a successful login.
+         * Ensure that `user_activation_key` is cleared after a successful login.
          *
          * @ticket 58901
+         *
+         * @covers ::wp_signon
          */
         public function test_user_activation_key_after_successful_login() {
                 global $wpdb;
 
-                $reset_key                    = get_password_reset_key( $this->user );
-                $user                         = wp_signon(
+                $password_reset_key = get_password_reset_key( $this->user );
+                $user               = wp_signon(
                         array(
                                 'user_login'    => self::USER_LOGIN,
@@ -439 +441 @@
                         )
                 );
+
                 $activation_key_from_database = $wpdb->get_var(
                         $wpdb->prepare( "SELECT user_activation_key FROM $wpdb->users WHERE ID = %d", $this->user->ID )
                 );
 
-                $this->assertNotWPError( $reset_key, 'The password reset key was not created.' );
+                $this->assertNotWPError( $password_reset_key, 'The password reset key was not created.' );
                 $this->assertNotWPError( $user, 'The user was not authenticated.' );
-                $this->assertEmpty( $user->user_activation_key, 'The `user_activation_key` was not empty on the user object returned by `wp_signon` function.' );
+                $this->assertEmpty( $user->user_activation_key, 'The `user_activation_key` was not empty on the user object returned by `wp_signon()` function.' );
                 $this->assertEmpty( $activation_key_from_database, 'The `user_activation_key` was not empty in the database.' );
         }