Changeset 34268

Timestamp:

09/17/2015 07:29:46 PM (9 years ago)

Author:

boonebgorges

Message:

Prime comment meta caches in WP_Comment_Query.

The new 'update_comment_meta_cache' parameter, which defaults to true, can
be used to disable this behavior.

update_comment_cache() has been updated to support an $update_meta_cache
parameter, which also updates to true; this matches the pattern we use for
priming post caches.

See #16894.

Location:

trunk

Files:

• src/wp-includes/class-wp-comment-query.php (modified) (4 diffs)
• src/wp-includes/comment-functions.php (modified) (1 diff)
• tests/phpunit/tests/comment/metaCache.php (modified) (1 diff)

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

@@ -95 +95 @@
      * @since 4.2.0
      * @since 4.4.0 `$parent__in` and `$parent__not_in` were added.
-     * @since 4.4.0 Order by `comment__in` was added.
+     * @since 4.4.0 Order by `comment__in` was added. `$update_comment_meta_cache` was added.
      * @access public
      *
@@ -162 +162 @@
      *     @type array        $type__not_in        Exclude comments from a given array of comment types. Default empty.
      *     @type int          $user_id             Include comments for a specific user ID. Default empty.
+     *     @type bool         $update_comment_meta_cache Whether to prime the metadata cache for found comments.
+     *                                                   Default true.
      * }
      */
@@ -202 +204 @@
             'meta_query' => '',
             'date_query' => null, // See WP_Date_Query
+            'update_comment_meta_cache' => true,
         );
 
@@ -699 +702 @@
         wp_cache_add( $cache_key, $comments, 'comment' );
         if ( '*' === $fields ) {
-            update_comment_cache( $comments );
+            update_comment_cache( $comments, $this->query_vars['update_comment_meta_cache'] );
         }
 

trunk/src/wp-includes/comment-functions.php

@@ -2358 +2358 @@
  *
  * @since 2.3.0
- *
- * @param array $comments Array of comment row objects
- */
-function update_comment_cache($comments) {
+ * @since 4.4.0 Introduced the `$update_meta_cache` parameter.
+ *
+ * @param array $comments          Array of comment row objects
+ * @param bool  $update_meta_cache Whether to update commentmeta cache. Default true.
+ */
+function update_comment_cache( $comments, $update_meta_cache = true ) {
     foreach ( (array) $comments as $comment )
         wp_cache_add($comment->comment_ID, $comment, 'comment');
+
+    if ( $update_meta_cache ) {
+        // Avoid `wp_list_pluck()` in case `$comments` is passed by reference.
+        $comment_ids = array();
+        foreach ( $comments as $comment ) {
+            $comment_ids[] = $comment->comment_ID;
+        }
+        update_meta_cache( 'comment', $comment_ids );
+    }
 }
 

trunk/tests/phpunit/tests/comment/metaCache.php

@@ -4 +4 @@
     protected $i = 0;
     protected $queries = 0;
+
+    /**
+     * @ticket 16894
+     */
+    public function test_update_comment_meta_cache_should_default_to_true() {
+        global $wpdb;
+
+        $p = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+        $comment_ids = $this->factory->comment->create_post_comments( $p, 3 );
+
+        foreach ( $comment_ids as $cid ) {
+            update_comment_meta( $cid, 'foo', 'bar' );
+        }
+
+        $q = new WP_Comment_Query( array(
+            'post_ID' => $p,
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+        foreach ( $comment_ids as $cid ) {
+            get_comment_meta( $cid, 'foo', 'bar' );
+        }
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket 16894
+     */
+    public function test_update_comment_meta_cache_true() {
+        global $wpdb;
+
+        $p = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+        $comment_ids = $this->factory->comment->create_post_comments( $p, 3 );
+
+        foreach ( $comment_ids as $cid ) {
+            update_comment_meta( $cid, 'foo', 'bar' );
+        }
+
+        $q = new WP_Comment_Query( array(
+            'post_ID' => $p,
+            'update_comment_meta_cache' => true,
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+        foreach ( $comment_ids as $cid ) {
+            get_comment_meta( $cid, 'foo', 'bar' );
+        }
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
+
+    /**
+     * @ticket 16894
+     */
+    public function test_update_comment_meta_cache_false() {
+        global $wpdb;
+
+        $p = $this->factory->post->create( array( 'post_status' => 'publish' ) );
+        $comment_ids = $this->factory->comment->create_post_comments( $p, 3 );
+
+        foreach ( $comment_ids as $cid ) {
+            update_comment_meta( $cid, 'foo', 'bar' );
+        }
+
+        $q = new WP_Comment_Query( array(
+            'post_ID' => $p,
+            'update_comment_meta_cache' => false,
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+        foreach ( $comment_ids as $cid ) {
+            get_comment_meta( $cid, 'foo', 'bar' );
+        }
+
+        $this->assertSame( $num_queries + 3, $wpdb->num_queries );
+    }
 
     public function test_comment_meta_cache() {