Changeset 53483

Timestamp:

06/10/2022 03:15:07 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Query: Some documentation and test improvements for update_post_author_caches():

• Make the descriptions for update_post_author_caches() and update_post_caches() more specific.
• Move the unit test into its own file, for consistency with update_post_cache() tests. This also allows for using shared fixtures in case more tests are added in the future.

Follow-up to [53482].

See #55716.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (1 diff)
• src/wp-includes/pluggable.php (modified) (1 diff)
• src/wp-includes/post.php (modified) (3 diffs)
• tests/phpunit/tests/post/updatePostAuthorCaches.php (added)
• tests/phpunit/tests/post/updatePostCache.php (modified) (3 diffs)
• tests/phpunit/tests/query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-query.php

@@ -3435 +3435 @@
     public function the_post() {
         global $post;
+
         if ( ! $this->in_the_loop ) {
             update_post_author_caches( $this->posts );
         }
+
         $this->in_the_loop = true;
 

trunk/src/wp-includes/pluggable.php

@@ -144 +144 @@
 
         $users = $wpdb->get_results( "SELECT * FROM $wpdb->users WHERE ID IN ($list)" );
+
         foreach ( $users as $user ) {
             update_user_caches( $user );

trunk/src/wp-includes/post.php

@@ -7425 +7425 @@
 
 /**
- * Calls major cache updating functions for list of Post objects.
+ * Updates post, term, and metadata caches for a list of post objects.
  *
  * @since 1.5.0
  *
- * @param WP_Post[] $posts             Array of Post objects
+ * @param WP_Post[] $posts             Array of post objects (passed by reference).
  * @param string    $post_type         Optional. Post type. Default 'post'.
  * @param bool      $update_term_cache Optional. Whether to update the term cache. Default true.
@@ -7476 +7476 @@
 
 /**
- * Prime post author user caches.
+ * Updates post author user caches for a list of post objects.
  *
  * @since 6.1.0
  *
- * @param WP_Post[] $posts Array of Post objects
+ * @param WP_Post[] $posts Array of post objects.
  */
 function update_post_author_caches( $posts ) {
@@ -7486 +7486 @@
     $author_ids = array_map( 'absint', $author_ids );
     $author_ids = array_unique( array_filter( $author_ids ) );
+
     cache_users( $author_ids );
 }
 
 /**
- * Updates metadata cache for list of post IDs.
+ * Updates metadata cache for a list of post IDs.
  *
  * Performs SQL query to retrieve the metadata for the post IDs and updates the

trunk/tests/phpunit/tests/post/updatePostCache.php

@@ -1 +1 @@
 <?php
 /**
- * Test `wp_update_cache()`.
+ * Test `update_post_cache()`.
  *
  * @package WordPress
@@ -7 +7 @@
 
 /**
- * Test class for `wp_update_cache()`.
+ * Test class for `update_post_cache()`.
  *
  * @group post
@@ -19 +19 @@
      * Post IDs from the shared fixture.
      *
-     * @var array
+     * @var int[]
      */
     public static $post_ids;

trunk/tests/phpunit/tests/query.php

@@ -622 +622 @@
 
     /**
-     * @ticket 55716
-     */
-    public function test_prime_user_cache() {
-        $action = new MockAction();
-        add_filter( 'update_user_metadata_cache', array( $action, 'filter' ), 10, 2 );
-        $user_ids = array();
-        $count    = 5;
-        for ( $i = 0; $i < $count; $i ++ ) {
-            $user_ids[ $i ] = self::factory()->user->create();
-            self::factory()->post->create(
-                array(
-                    'post_type'   => 'post',
-                    'post_author' => $user_ids[ $i ],
-                )
-            );
-        }
-
-        $q = new WP_Query(
-            array(
-                'post_type'      => 'post',
-                'posts_per_page' => $count,
-            )
-        );
-        while ( $q->have_posts() ) {
-            $q->the_post();
-        }
-
-        $args      = $action->get_args();
-        $last_args = end( $args );
-        $this->assertSameSets( $user_ids, $last_args[1], 'Ensure that user ids are primed' );
-    }
-
-    /**
      * @ticket 35601
      */