Changeset 59235

Timestamp:

10/14/2024 10:20:09 PM (7 weeks ago)

Author:

peterwilsoncc

Message:

Media: Account for post ID queries in update_post_thumbnail_cache().

Updates update_post_thumbnail_cache() to account for WP_Query objects that only contain the post ID field rather than the entire post object.

This changes passes the $post value to get_post_thumbnail_id() rather than assuming the presence of the ID property. Additionally, the posts to which the thumbnail is attached are now primed prior to calling the function to avoid numerous unnecessary database queries.

The test WP_Test_REST_Posts_Controller::test_get_items_primes_parent_post_caches() is modified to account for an order of operations change for the priming of post meta caches. The cache is no longer primed in the final call to update_meta_cache() so the tests need to account for the post meta to be primed in any call to the function.

Props antpb, jorbin, khokansardar, linsoftware, mukesh27, oglekler, rajinsharwar, sumitsingh, xendo.
Fixes #59521.

Location:

trunk

Files:

• src/wp-includes/post-thumbnail-template.php (modified) (1 diff)
• tests/phpunit/tests/post/thumbnails.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

trunk/src/wp-includes/post-thumbnail-template.php

@@ -113 +113 @@
     $thumb_ids = array();
 
+    /*
+     * $wp_query may contain an array of post objects or post IDs.
+     *
+     * This ensures the cache is primed for all post objects to avoid
+     * `get_post()` calls in `get_the_post_thumbnail()` triggering an
+     * additional database call for each post.
+     */
+    $parent_post_ids = array();
     foreach ( $wp_query->posts as $post ) {
-        $id = get_post_thumbnail_id( $post->ID );
+        if ( $post instanceof WP_Post ) {
+            $parent_post_ids[] = $post->ID;
+        } elseif ( is_int( $post ) ) {
+            $parent_post_ids[] = $post;
+        }
+    }
+    _prime_post_caches( $parent_post_ids, false, true );
+
+    foreach ( $wp_query->posts as $post ) {
+        $id = get_post_thumbnail_id( $post );
         if ( $id ) {
             $thumb_ids[] = $id;

trunk/tests/phpunit/tests/post/thumbnails.php

@@ -69 +69 @@
     }
 
-    public function test_update_post_thumbnail_cache() {
-        set_post_thumbnail( self::$post, self::$attachment_id );
-
+    /**
+     * Ensure `update_post_thumbnail_cache()` works when querying post objects.
+     *
+     * @ticket 59521
+     * @ticket 30017
+     * @ticket 33968
+     *
+     * @covers ::update_post_thumbnail_cache
+     */
+    public function test_update_post_thumbnail_cache_when_querying_full_post_objects() {
+        set_post_thumbnail( self::$post, self::$attachment_id );
+
+        // Test case where `$query->posts` should return Array of post objects.
         $query = new WP_Query(
             array(
@@ -80 +90 @@
         );
 
-        $this->assertFalse( $query->thumbnails_cached );
+        $this->assertFalse( $query->thumbnails_cached, 'Thumbnails should not be cached prior to calling update_post_thumbnail_cache().' );
 
         update_post_thumbnail_cache( $query );
 
-        $this->assertTrue( $query->thumbnails_cached );
+        $this->assertTrue( $query->thumbnails_cached, 'Thumbnails should be cached after calling update_post_thumbnail_cache().' );
+    }
+
+    /**
+     * Ensure `update_post_thumbnail_cache()` works when querying post IDs.
+     *
+     * @ticket 59521
+     *
+     * @covers ::update_post_thumbnail_cache
+     */
+    public function test_update_post_thumbnail_cache_when_querying_post_id_field() {
+        set_post_thumbnail( self::$post, self::$attachment_id );
+
+        // Test case where `$query2->posts` should return Array of post IDs.
+        $query = new WP_Query(
+            array(
+                'post_type' => 'any',
+                'post__in'  => array( self::$post->ID ),
+                'orderby'   => 'post__in',
+                'fields'    => 'ids',
+            )
+        );
+
+        $this->assertFalse( $query->thumbnails_cached, 'Thumbnails should not be cached prior to calling update_post_thumbnail_cache().' );
+
+        update_post_thumbnail_cache( $query );
+
+        $this->assertTrue( $query->thumbnails_cached, 'Thumbnails should be cached after calling update_post_thumbnail_cache().' );
     }
 

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -1713 +1713 @@
         rest_get_server()->dispatch( $request );
 
-        $args = $filter->get_args();
-        $last = end( $args );
-        $this->assertIsArray( $last, 'The last value is not an array' );
-        $this->assertSameSets( $parent_ids, $last[1] );
+        $events = $filter->get_events();
+        $args   = wp_list_pluck( $events, 'args' );
+        $primed = false;
+        sort( $parent_ids );
+        foreach ( $args as $arg ) {
+            sort( $arg[1] );
+            if ( $parent_ids === $arg[1] ) {
+                $primed = $arg;
+                break;
+            }
+        }
+
+        $this->assertIsArray( $primed, 'The last value is not an array' );
+        $this->assertSameSets( $parent_ids, $primed[1] );
     }