Changeset 60989

Timestamp:

10/20/2025 07:59:15 PM (5 weeks ago)

Author:

spacedmonkey

Message:

Users: Lazy-load user meta.

In [36566], a framework for lazily loading metadata was introduced, initially supporting term and comment meta. This commit extends that support to user meta.

User meta can contain a large amount of data that is not always needed, particularly on the front end. To address this, cache_users() now calls the new function wp_lazyload_user_meta(). This function accepts an array of user IDs and adds them to the queue of metadata to be lazily loaded.

Follows on from [55671], [55747].

Props spacedmonkey, westonruter.
Fixes #63021.

Location:

trunk

Files:

• src/wp-includes/class-wp-metadata-lazyloader.php (modified) (1 diff)
• src/wp-includes/pluggable.php (modified) (1 diff)
• src/wp-includes/user.php (modified) (1 diff)
• tests/phpunit/includes/abstract-testcase.php (modified) (1 diff)
• tests/phpunit/tests/post/updatePostAuthorCaches.php (modified) (1 diff)
• tests/phpunit/tests/query/cacheResults.php (modified) (1 diff)
• tests/phpunit/tests/query/thePost.php (modified) (1 diff)
• tests/phpunit/tests/user/lazyLoadMeta.php (added)

trunk/src/wp-includes/class-wp-metadata-lazyloader.php

@@ -64 +64 @@
             'blog'    => array(
                 'filter'   => 'get_blog_metadata',
+                'callback' => array( $this, 'lazyload_meta_callback' ),
+            ),
+            'user'    => array(
+                'filter'   => 'get_user_metadata',
                 'callback' => array( $this, 'lazyload_meta_callback' ),
             ),

trunk/src/wp-includes/pluggable.php

@@ -126 +126 @@
         global $wpdb;
 
-        update_meta_cache( 'user', $user_ids );
+        $user_ids = array_unique( array_map( 'intval', $user_ids ), SORT_NUMERIC );
+        wp_lazyload_user_meta( $user_ids );
 
         $clean = _get_non_cached_ids( $user_ids, 'users' );

trunk/src/wp-includes/user.php

@@ -1319 +1319 @@
 function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) {
     return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value );
+}
+
+/**
+ * Queue user meta for lazy-loading.
+ *
+ * @since 6.9.0
+ *
+ * @param int[] $user_ids List of user IDs.
+ */
+function wp_lazyload_user_meta( array $user_ids ) {
+    if ( empty( $user_ids ) ) {
+        return;
+    }
+    $lazyloader = wp_metadata_lazyloader();
+    $lazyloader->queue_objects( 'user', $user_ids );
 }
 

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -304 +304 @@
         $lazyloader->reset_queue( 'comment' );
         $lazyloader->reset_queue( 'blog' );
+        $lazyloader->reset_queue( 'user' );
     }
 

trunk/tests/phpunit/tests/post/updatePostAuthorCaches.php

@@ -68 +68 @@
         }
 
+        $this->assertSame( 0, $action->get_call_count(), 'Ensure that user meta are not primed' );
+    }
+
+    /**
+     * @ticket 63021
+     */
+    public function test_update_post_author_caches_force_load_meta() {
+        $action = new MockAction();
+        add_filter( 'update_user_metadata_cache', array( $action, 'filter' ), 10, 2 );
+
+        $q = new WP_Query(
+            array(
+                'post_type'      => 'post',
+                'posts_per_page' => self::$post_author_count,
+            )
+        );
+
+        while ( $q->have_posts() ) {
+            $q->the_post();
+            get_the_author_meta(); // Force loading of author meta.
+        }
+
         $args      = $action->get_args();
         $last_args = end( $args );

trunk/tests/phpunit/tests/query/cacheResults.php

@@ -1983 +1983 @@
         $num_loop_queries = get_num_queries() - $start_loop_queries;
         /*
-         * Two expected queries:
-         * 1: User meta data,
-         * 2: User data.
+         * One expected query:
+         * 1: User data.
          */
-        $this->assertSame( 2, $num_loop_queries, 'Unexpected number of queries while initializing the loop.' );
+        $this->assertSame( 1, $num_loop_queries, 'Unexpected number of queries while initializing the loop.' );
 
         $start_author_queries = get_num_queries();

trunk/tests/phpunit/tests/query/thePost.php

@@ -266 +266 @@
     public function data_the_loop_fields() {
         return array(
-            'all fields'                => array( 'all', 2 ),
-            'all fields (empty fields)' => array( '', 2 ),
-            'post IDs'                  => array( 'ids', 4 ),
-            'post ids and parent'       => array( 'id=>parent', 4 ),
+            'all fields'                => array( 'all', 1 ),
+            'all fields (empty fields)' => array( '', 1 ),
+            'post IDs'                  => array( 'ids', 3 ),
+            'post ids and parent'       => array( 'id=>parent', 3 ),
         );
     }