Changeset 55608

Timestamp:

03/29/2023 10:48:34 AM (2 years ago)

Author:

spacedmonkey

Message:

Options, Meta APIs: Improve the lazy loading meta API to include current object id.

The existing lazy loading meta api, creates a queue of ids, to be primed, if the get_comment_meta or get_term_meta functions are called. However, it did not check to see if the requested id was in the queue, before prime all the ids in the queue. Now, it adds the id to the queue, is not already in the queue, saving a cache lookup / database query.

Props spacedmonkey, peterwilsoncc, mukesh27, flixos90.
Fixes #57901.

Location:

trunk

Files:

• src/wp-includes/class-wp-metadata-lazyloader.php (modified) (6 diffs)
• tests/phpunit/tests/query/lazyLoadCommentMeta.php (added)
• tests/phpunit/tests/query/lazyLoadTermMeta.php (modified) (2 diffs)

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

@@ -56 +56 @@
             'term'    => array(
                 'filter'   => 'get_term_metadata',
-                'callback' => array( $this, 'lazyload_term_meta' ),
+                'callback' => array( $this, 'lazyload_meta_callback' ),
             ),
             'comment' => array(
                 'filter'   => 'get_comment_metadata',
-                'callback' => array( $this, 'lazyload_comment_meta' ),
+                'callback' => array( $this, 'lazyload_meta_callback' ),
             ),
         );
@@ -92 +92 @@
         }
 
-        add_filter( $type_settings['filter'], $type_settings['callback'] );
+        add_filter( $type_settings['filter'], $type_settings['callback'], 10, 5 );
 
         /**
@@ -132 +132 @@
      *
      * @since 4.5.0
+     * @deprecated 6.3.0 Use WP_Metadata_Lazyloader::lazyload_meta_callback() instead.
      *
      * @param mixed $check The `$check` param passed from the 'get_term_metadata' hook.
@@ -138 +139 @@
      */
     public function lazyload_term_meta( $check ) {
-        if ( ! empty( $this->pending_objects['term'] ) ) {
-            update_termmeta_cache( array_keys( $this->pending_objects['term'] ) );
-
-            // No need to run again for this set of terms.
-            $this->reset_queue( 'term' );
-        }
-
-        return $check;
+        _deprecated_function( __METHOD__, '6.3.0', 'WP_Metadata_Lazyloader::lazyload_meta_callback' );
+        return $this->lazyload_meta_callback( $check, 0, '', false, 'term' );
     }
 
@@ -155 +150 @@
      *
      * @since 4.5.0
+     * @deprecated 6.3.0 Use WP_Metadata_Lazyloader::lazyload_meta_callback() instead.
      *
      * @param mixed $check The `$check` param passed from the {@see 'get_comment_metadata'} hook.
@@ -160 +156 @@
      */
     public function lazyload_comment_meta( $check ) {
-        if ( ! empty( $this->pending_objects['comment'] ) ) {
-            update_meta_cache( 'comment', array_keys( $this->pending_objects['comment'] ) );
+        _deprecated_function( __METHOD__, '6.3.0', 'WP_Metadata_Lazyloader::lazyload_meta_callback' );
+        return $this->lazyload_meta_callback( $check, 0, '', false, 'comment' );
+    }
 
-            // No need to run again for this set of comments.
-            $this->reset_queue( 'comment' );
+    /**
+     * Lazy-loads meta for queued objects.
+     *
+     * This method is public so that it can be used as a filter callback. As a rule, there
+     * is no need to invoke it directly.
+     *
+     * @since 6.3.0
+     *
+     * @param mixed  $check     The `$check` param passed from the 'get_*_metadata' hook.
+     * @param int    $object_id ID of the object metadata is for.
+     * @param string $meta_key  Unused.
+     * @param bool   $single    Unused.
+     * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
+     *                          or any other object type with an associated meta table.
+     * @return mixed In order not to short-circuit `get_metadata()`. Generally, this is `null`, but it could be
+     *               another value if filtered by a plugin.
+     */
+    public function lazyload_meta_callback( $check, $object_id, $meta_key, $single, $meta_type ) {
+        if ( empty( $this->pending_objects[ $meta_type ] ) ) {
+            return $check;
         }
+
+        $object_ids = array_keys( $this->pending_objects[ $meta_type ] );
+        if ( $object_id && ! in_array( $object_id, $object_ids, true ) ) {
+            $object_ids[] = $object_id;
+        }
+
+        update_meta_cache( $meta_type, $object_ids );
+
+        // No need to run again for this set of objects.
+        $this->reset_queue( $meta_type );
 
         return $check;

trunk/tests/phpunit/tests/query/lazyLoadTermMeta.php

@@ -109 +109 @@
     }
 
+
+    /**
+     * @ticket 57901
+     *
+     * @covers ::wp_queue_posts_for_term_meta_lazyload
+     */
+    public function test_wp_queue_posts_for_term_meta_lazyload_insert_term() {
+        $filter = new MockAction();
+        add_filter( 'update_term_metadata_cache', array( $filter, 'filter' ), 10, 2 );
+
+        register_taxonomy( 'wptests_tax', 'post' );
+
+        $t1      = wp_insert_term( 'Foo', 'wptests_tax' );
+        $term_id = $t1['term_id'];
+
+        new WP_Query(
+            array(
+                'post__in'            => self::$post_ids,
+                'lazy_load_term_meta' => true,
+            )
+        );
+
+        get_term_meta( $term_id );
+
+        $args     = $filter->get_args();
+        $first    = reset( $args );
+        $term_ids = end( $first );
+        $this->assertContains( $term_id, $term_ids );
+    }
+
     /**
      * @ticket 57150
@@ -134 +164 @@
         $first    = reset( $args );
         $term_ids = end( $first );
-        $this->assertNotContains( $remove_term_id, $term_ids );
+        $this->assertContains( $remove_term_id, $term_ids );
     }
 }