Changeset 50790

Timestamp:

04/26/2021 01:02:34 AM (3 years ago)

Author:

peterwilsoncc

Message:

Users: Share current user instance across functions.

Share the WP_User instance for the current user between the functions get_userdata() and wp_get_current_user(). Both functions return the $current_user global for the current user.

Force refresh the $current_user global within clean_user_cache() by immediately re-calling wp_set_current_user() with the current user's ID. This ensures any changes to the current user's permissions or other settings are reflected in the global. As a side-effect this immediately rewarms the current user's cache.

Props chaion07, chriscct7, donmhico, hellofromtonya, lukecarbis, peterwilsoncc, rmccue, TimothyBlynJacobs.
Fixes #28020.

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (2 diffs)
• src/wp-includes/user.php (modified) (2 diffs)
• tests/phpunit/tests/pluggable.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -92 +92 @@
      * @since 2.8.0
      * @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
+     * @since 5.8.0 Returns the global `$current_user` if it's the user being fetched.
      *
      * @param string     $field The field to retrieve the user with. id | ID | slug | email | login.
@@ -98 +99 @@
      */
     function get_user_by( $field, $value ) {
+        global $current_user;
+
         $userdata = WP_User::get_data_by( $field, $value );
 
         if ( ! $userdata ) {
             return false;
+        }
+
+        if ( $current_user instanceof WP_User && $current_user->ID === (int) $userdata->ID ) {
+            return $current_user;
         }
 

trunk/src/wp-includes/user.php

@@ -1562 +1562 @@
  * @since 3.0.0
  * @since 4.4.0 'clean_user_cache' action was added.
+ * @since 5.8.0 Refreshes the global user instance if cleaning the user cache for the current user.
+ *
+ * @global WP_User $current_user The current user object which holds the user data.
  *
  * @param WP_User|int $user User object or ID to be cleaned from the cache
  */
 function clean_user_cache( $user ) {
+    global $current_user;
+
     if ( is_numeric( $user ) ) {
         $user = new WP_User( $user );
@@ -1588 +1593 @@
      */
     do_action( 'clean_user_cache', $user->ID, $user );
+
+    // Refresh the global user instance if the cleaning current user.
+    if ( get_current_user_id() === (int) $user->ID ) {
+        $user_id      = (int) $user->ID;
+        $current_user = null;
+        wp_set_current_user( $user_id, '' );
+    }
 }
 

trunk/tests/phpunit/tests/pluggable.php

@@ -325 +325 @@
     }
 
+    /**
+     * @ticket 28020
+     */
+    public function test_get_user_by_should_return_same_instance_as_wp_get_current_user() {
+        // Create a test user
+        $new_user = self::factory()->user->create( array( 'role' => 'subscriber' ) );
+
+        // Set the test user as the current user
+        $current_user = wp_set_current_user( $new_user );
+
+        // Get the test user using get_user_by()
+        $from_get_user_by = get_user_by( 'id', $new_user );
+
+        $this->assertSame( $current_user, $from_get_user_by );
+    }
 }