Changeset 54634

Timestamp:

10/18/2022 03:06:48 PM (4 years ago)

Author:

spacedmonkey

Message:

Query: Remove placeholder from query cache key.

Remove escape placeholder from query cache key, as placeholders are a based on a unique id on every request. This means that it is impossible for a cache to be reused, making queries that use escape placeholders such as LIKE searches, unable to be cached.

Props dhl, spacedmonkey, peterwilsoncc, desrosj, chaion07, davidbaumwald, mukesh27.
Fixes #56802.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (2 diffs)
• tests/phpunit/tests/query/cacheResults.php (modified) (6 diffs)

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

@@ -3116 +3116 @@
                                 $cache_args['update_post_term_cache'],
                                 $cache_args['lazy_load_term_meta'],
-                                $cache_args['update_menu_item_cache']
+                                $cache_args['update_menu_item_cache'],
+                                $cache_args['search_orderby_title']
                         );
 
                         $new_request = str_replace( $fields, "{$wpdb->posts}.*", $this->request );
+                        $new_request = $wpdb->remove_placeholder_escape( $new_request );
                         $key         = md5( serialize( $cache_args ) . $new_request );
 
@@ -3127 +3129 @@
                         }
 
-                        $cache_key   = "wp_query:$key:$last_changed";
+                        $cache_key = "wp_query:$key:$last_changed";
+
+                        /**
+                         * Filters query cache key.
+                         *
+                         * @since 6.1.0
+                         *
+                         * @param string   $cache_key   Cache key.
+                         * @param array    $cache_args  Query args used to generate the cache key.
+                         * @param string   $new_request SQL Query.
+                         * @param WP_Query $query       The WP_Query instance.
+                         */
+                        $cache_key = apply_filters( 'wp_query_cache_key', $cache_key, $cache_args, $new_request, $this );
+
                         $cache_found = false;
                         if ( null === $this->posts ) {

trunk/tests/phpunit/tests/query/cacheResults.php

@@ -33 +33 @@
          */
         public static $author_id;
+
+        /**
+         * @var array
+         */
+        protected $cache_args;
+
+        /**
+         * @var string
+         */
+        protected $new_request;
 
         public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
@@ -58 +68 @@
         }
 
+        function set_up() {
+                parent::set_up();
+                $this->cache_args  = null;
+                $this->new_request = null;
+                add_filter( 'wp_query_cache_key', array( $this, 'filter_wp_query_cache_key' ), 15, 3 );
+        }
+
         /**
          * @dataProvider data_query_cache
@@ -63 +80 @@
          */
         public function test_query_cache( $args ) {
-                $query1 = new WP_Query();
-                $posts1 = $query1->query( $args );
+                global $wpdb;
+
+                $query1 = new WP_Query();
+                $posts1 = $query1->query( $args );
+
+                $placeholder = $wpdb->placeholder_escape();
+                $this->assertNotEmpty( $this->new_request, 'Check new request is not empty' );
+                $this->assertStringNotContainsString( $placeholder, $this->new_request, 'Check if request does not contain placeholder' );
+                $this->assertStringNotContainsString( $placeholder, wp_json_encode( $this->cache_args ), 'Check if cache arrays does not contain placeholder' );
 
                 $queries_before = get_num_queries();
@@ -192 +216 @@
                                 ),
                         ),
+                        'cache meta query search'                     => array(
+                                'args' => array(
+                                        'cache_results' => true,
+                                        'meta_query'    => array(
+                                                array(
+                                                        'key'     => 'color',
+                                                        'value'   => '00',
+                                                        'compare' => 'LIKE',
+                                                ),
+                                        ),
+                                ),
+                        ),
+                        'cache meta query not search'                 => array(
+                                'args' => array(
+                                        'cache_results' => true,
+                                        'meta_query'    => array(
+                                                array(
+                                                        'key'     => 'color',
+                                                        'value'   => 'ff',
+                                                        'compare' => 'NOT LIKE',
+                                                ),
+                                        ),
+                                ),
+                        ),
                         'cache comment_count'                         => array(
                                 'args' => array(
@@ -208 +256 @@
                                                 ),
                                         ),
+                                ),
+                        ),
+                        'cache search query'                          => array(
+                                'args' => array(
+                                        'cache_results' => true,
+                                        's'             => 'title',
+                                ),
+                        ),
+                        'cache search query multiple terms'           => array(
+                                'args' => array(
+                                        'cache_results' => true,
+                                        's'             => 'Post title',
                                 ),
                         ),
@@ -828 +888 @@
         }
 
+        public function filter_wp_query_cache_key( $cache_key, $cache_args, $new_request ) {
+                $this->cache_args  = $cache_args;
+                $this->new_request = $new_request;
+
+                return $cache_key;
+        }
+
         /**
          * @ticket 22176