Changeset 54940

Timestamp:

12/06/2022 01:52:02 PM (23 months ago)

Author:

spacedmonkey

Message:

Users: Clear the user_meta cache when clean_user_cache function is called.

Unlike other clean cache functions like clean_post_cache, clean_user_cache did not also clear user meta caches. This is inconsistent and can result in some strange side effects. Update the clean_user_cache function to also clear user meta caches when called.

Props dd32, spacedmonkey, peterwilsoncc.
Fixes #54316.

Location:

trunk

Files:

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

trunk/src/wp-includes/user.php

@@ -1874 +1874 @@
  * @since 3.0.0
  * @since 4.4.0 'clean_user_cache' action was added.
+ * @since 6.2.0 User metadata caches are now cleared.
  *
  * @param WP_User|int $user User object or ID to be cleaned from the cache
@@ -1893 +1894 @@
         wp_cache_delete( $user->user_email, 'useremail' );
     }
+
+    wp_cache_delete( $user->ID, 'user_meta' );
 
     /**

trunk/tests/phpunit/tests/meta/updateMetadata.php

@@ -28 +28 @@
         $this->assertSame( 'baz', $found );
     }
+
+    /**
+     * @ticket 54316
+     *
+     * @group user
+     *
+     * @covers ::clean_user_cache
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     */
+    public function test_clear_user_metadata_caches() {
+        global $wpdb;
+
+        $user_id = self::factory()->user->create();
+
+        update_metadata( 'user', $user_id, 'key', 'value1' );
+
+        $found = get_metadata( 'user', $user_id, 'key', true );
+        $this->assertSame( 'value1', $found );
+
+        // Simulate updating the DB from outside of WordPress.
+        $wpdb->update(
+            $wpdb->usermeta,
+            array(
+                'meta_value' => 'value2',
+            ),
+            array(
+                'user_id'  => $user_id,
+                'meta_key' => 'key',
+            )
+        );
+
+        // Clear the user caches.
+        clean_user_cache( $user_id );
+
+        // Verify metadata cache was cleared.
+        $found = get_metadata( 'user', $user_id, 'key', true );
+        $this->assertSame( 'value2', $found );
+    }
+
+    /**
+     * @ticket 54316
+     *
+     * @group user
+     *
+     * @covers ::clean_user_cache
+     *
+     * @global wpdb $wpdb WordPress database abstraction object.
+     */
+    public function test_clear_post_metadata_caches() {
+        global $wpdb;
+
+        $post_id = self::factory()->post->create();
+
+        update_metadata( 'post', $post_id, 'key', 'value1' );
+
+        $found = get_metadata( 'post', $post_id, 'key', true );
+        $this->assertSame( 'value1', $found );
+
+        // Simulate updating the DB from outside of WordPress.
+        $wpdb->update(
+            $wpdb->postmeta,
+            array(
+                'meta_value' => 'value2',
+            ),
+            array(
+                'post_id'  => $post_id,
+                'meta_key' => 'key',
+            )
+        );
+
+        // Clear the post caches.
+        clean_post_cache( $post_id );
+
+        // Verify metadata cache was cleared.
+        $found = get_metadata( 'post', $post_id, 'key', true );
+        $this->assertSame( 'value2', $found );
+    }
+
 }