Changeset 53169

Timestamp:

04/13/2022 02:55:34 AM (4 years ago)

Author:

peterwilsoncc

Message:

Cache API: Improve cache key generation in WP_Comment_Query.

Discard the parameters update_comment_meta_cache and update_comment_post_cache when generating the cache key as neither have an effect on the database query generated.

Props uday17035, spacedmonkey.
Fixes #55460.

Location:

trunk

Files:

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

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

@@ -445 +445 @@
                 /*
                  * Only use the args defined in the query_var_defaults to compute the key,
-                 * but ignore 'fields', which does not affect query results.
+                 * but ignore 'fields', 'update_comment_meta_cache', 'update_comment_post_cache' which does not affect query results.
                  */
                 $_args = wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) );
-                unset( $_args['fields'] );
+                unset( $_args['fields'], $_args['update_comment_meta_cache'], $_args['update_comment_post_cache'] );
 
                 $key          = md5( serialize( $_args ) );

trunk/tests/phpunit/tests/comment/query.php

@@ -4942 +4942 @@
                 return array( get_comment( $c ) );
         }
+
+        /**
+         * @ticket 55460
+         */
+        public function test_comment_cache_key_should_ignore_unset_params() {
+                $p = self::factory()->post->create();
+                $c = self::factory()->comment->create( array( 'comment_post_ID' => $p ) );
+
+                $_args = array(
+                        'post_id'                   => $p,
+                        'fields'                    => 'ids',
+                        'update_comment_meta_cache' => true,
+                        'update_comment_post_cache' => false,
+                );
+
+                $q1 = new WP_Comment_Query();
+                $q1->query( $_args );
+
+                $num_queries_all_args = get_num_queries();
+
+                // Ignore 'fields', 'update_comment_meta_cache', 'update_comment_post_cache'.
+                unset( $_args['fields'], $_args['update_comment_meta_cache'], $_args['update_comment_post_cache'] );
+                $q2 = new WP_Comment_Query();
+                $q2->query( $_args );
+
+                $this->assertSame( $num_queries_all_args, get_num_queries() );
+        }
 }