Changeset 56656 for trunk/tests/phpunit/tests/query/cacheResults.php

Timestamp:

09/21/2023 07:32:55 PM (16 months ago)

Author:

spacedmonkey

Message:

Query: Improved handling of filtered queries in WP_Query.

The WP_Query class enables developers to customize queries using filters like posts_fields_request, posts_request, and the_posts, which can modify both the queried fields and retrieved post objects. In some cases with these filters, incomplete or invalid post objects lacking essential data may arise. To address this, if any of these filters are active during a query, the get_posts method now avoids caching post objects with the usual update_post_caches function call, opting for a call to _prime_post_caches instead. This may occasionally trigger new database queries to prime the post data cache. While this enhancement may result in rare additional database queries, it ensures that invalid post objects aren't cached, prioritizing data consistency and integrity in filtered query scenarios.

Props saulirajala, spacedmonkey, flixos90, mukesh27, peterwilsoncc.
Fixes #58599.

File:

• trunk/tests/phpunit/tests/query/cacheResults.php (modified) (1 diff)

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

@@ -1081 +1081 @@
 
     /**
+     * @ticket 58599
+     */
+    public function test_query_posts_fields_request() {
+        global $wpdb;
+
+        $args = array(
+            'update_post_meta_cache' => false,
+            'update_post_term_cache' => false,
+            'no_found_rows'          => true,
+        );
+
+        add_filter( 'posts_fields_request', array( $this, 'filter_posts_fields_request' ) );
+
+        $before = get_num_queries();
+        $query1 = new WP_Query();
+        $posts1 = $query1->query( $args );
+        $after  = get_num_queries();
+
+        foreach ( $posts1 as $_post ) {
+            $this->assertNotSame( get_post( $_post->ID )->post_content, $_post->post_content );
+        }
+
+        $this->assertSame( 2, $after - $before, 'There should only be 2 queries run, one for request and one prime post objects.' );
+
+        $this->assertStringContainsString(
+            "SELECT $wpdb->posts.*",
+            $wpdb->last_query,
+            'Check that _prime_post_caches is called.'
+        );
+    }
+
+    public function filter_posts_fields_request( $fields ) {
+        global $wpdb;
+        return "{$wpdb->posts}.ID";
+    }
+
+    /**
+     * @ticket 58599
+     * @dataProvider data_query_filter_posts_results
+     */
+    public function test_query_filter_posts_results( $filter ) {
+        global $wpdb;
+
+        $args = array(
+            'update_post_meta_cache' => false,
+            'update_post_term_cache' => false,
+            'no_found_rows'          => true,
+        );
+
+        add_filter( $filter, array( $this, 'filter_posts_results' ) );
+
+        $before = get_num_queries();
+        $query1 = new WP_Query();
+        $posts1 = $query1->query( $args );
+        $after  = get_num_queries();
+
+        $this->assertCount( 1, $posts1 );
+
+        $this->assertSame( 2, $after - $before, 'There should only be 2 queries run, one for request and one prime post objects.' );
+
+        $this->assertStringContainsString(
+            "SELECT $wpdb->posts.*",
+            $wpdb->last_query,
+            'Check that _prime_post_caches is called.'
+        );
+    }
+
+    public function filter_posts_results() {
+        return array( get_post( self::$posts[0] ) );
+    }
+
+    public function data_query_filter_posts_results() {
+        return array(
+            array( 'posts_results' ),
+            array( 'the_posts' ),
+        );
+    }
+
+    /**
      * @ticket 22176
      */