mirror of
git://develop.git.wordpress.org/
synced 2025-04-07 13:43:25 +02:00
Query: Bypass caching for filtered SELECTs.
Bypass caching within `WP_Query` when the `SELECT` clause has been modified via a filter. This prevents both cache key collisions and the returning of incomplete or unexpected results when the `SELECT` clause has been modified by an extender. Props pypwalters, claytoncollie, johnwatkins0, TimothyBlynJacobs, costdev, spacedmonkey, peterwilsoncc. Merges [54768] to the 6.1 branch. Fixes #57012. git-svn-id: https://develop.svn.wordpress.org/branches/6.1@54780 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Jonathan Desrosiers
parent
b818744dac
commit
c0f52496f7
@ -3103,8 +3103,23 @@ class WP_Query {
|
||||
* cannot be cached. Note the space before `RAND` in the string
|
||||
* search, that to ensure against a collision with another
|
||||
* function.
|
||||
*
|
||||
* If `$fields` has been modified by the `posts_fields`,
|
||||
* `posts_fields_request`, `post_clauses` or `posts_clauses_request`
|
||||
* filters, then caching is disabled to prevent caching collisions.
|
||||
*/
|
||||
$id_query_is_cacheable = ! str_contains( strtoupper( $orderby ), ' RAND(' );
|
||||
|
||||
$cachable_field_values = array(
|
||||
"{$wpdb->posts}.*",
|
||||
"{$wpdb->posts}.ID, {$wpdb->posts}.post_parent",
|
||||
"{$wpdb->posts}.ID",
|
||||
);
|
||||
|
||||
if ( ! in_array( $fields, $cachable_field_values, true ) ) {
|
||||
$id_query_is_cacheable = false;
|
||||
}
|
||||
|
||||
if ( $q['cache_results'] && $id_query_is_cacheable ) {
|
||||
$new_request = str_replace( $fields, "{$wpdb->posts}.*", $this->request );
|
||||
$cache_key = $this->generate_cache_key( $q, $new_request );
|
||||
|
||||
242
tests/phpunit/tests/query/fieldsClause.php
Normal file
242
tests/phpunit/tests/query/fieldsClause.php
Normal file
@ -0,0 +1,242 @@
|
||||
<?php
|
||||
/**
|
||||
* @group query
|
||||
*
|
||||
* @covers WP_Query::get_posts
|
||||
*/
|
||||
class Tests_Query_FieldsClause extends WP_UnitTestCase {
|
||||
|
||||
/**
|
||||
* Post IDs.
|
||||
*
|
||||
* @var int[]
|
||||
*/
|
||||
static $post_ids = array();
|
||||
|
||||
/**
|
||||
* Page IDs.
|
||||
*
|
||||
* @var int[]
|
||||
*/
|
||||
static $page_ids = array();
|
||||
|
||||
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
|
||||
// Register CPT for use with shared fixtures.
|
||||
register_post_type( 'wptests_pt' );
|
||||
|
||||
self::$post_ids = $factory->post->create_many( 5, array( 'post_type' => 'wptests_pt' ) );
|
||||
}
|
||||
|
||||
public function set_up() {
|
||||
parent::set_up();
|
||||
/*
|
||||
* Re-register the CPT for use within each test.
|
||||
*
|
||||
* Custom post types are deregistered by the default tear_down method
|
||||
* so need to be re-registered for each test as WP_Query calls
|
||||
* get_post_types().
|
||||
*/
|
||||
register_post_type( 'wptests_pt' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests limiting the WP_Query fields to the ID and parent sub-set.
|
||||
*
|
||||
* @ticket 57012
|
||||
*/
|
||||
public function test_should_limit_fields_to_id_and_parent_subset() {
|
||||
$query_args = array(
|
||||
'post_type' => 'wptests_pt',
|
||||
'fields' => 'id=>parent',
|
||||
);
|
||||
|
||||
$q = new WP_Query( $query_args );
|
||||
|
||||
$expected = array();
|
||||
foreach ( self::$post_ids as $post_id ) {
|
||||
// Use array_shift to populate in the reverse order.
|
||||
array_unshift(
|
||||
$expected,
|
||||
(object) array(
|
||||
'ID' => $post_id,
|
||||
'post_parent' => 0,
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$this->assertEquals( $expected, $q->posts, 'Posts property for first query is not of expected form.' );
|
||||
$this->assertSame( 5, $q->found_posts, 'Number of found posts is not five.' );
|
||||
$this->assertEquals( 1, $q->max_num_pages, 'Number of found pages is not one.' );
|
||||
|
||||
// Test the second query's results match.
|
||||
$q2 = new WP_Query( $query_args );
|
||||
$this->assertEquals( $expected, $q2->posts, 'Posts property for second query is not in the expected form.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests limiting the WP_Query fields to the IDs only.
|
||||
*
|
||||
* @ticket 57012
|
||||
*/
|
||||
public function test_should_limit_fields_to_ids() {
|
||||
$query_args = array(
|
||||
'post_type' => 'wptests_pt',
|
||||
'fields' => 'ids',
|
||||
);
|
||||
|
||||
$q = new WP_Query( $query_args );
|
||||
|
||||
$expected = array_reverse( self::$post_ids );
|
||||
|
||||
$this->assertEquals( $expected, $q->posts, 'Posts property for first query is not of expected form.' );
|
||||
$this->assertSame( 5, $q->found_posts, 'Number of found posts is not five.' );
|
||||
$this->assertEquals( 1, $q->max_num_pages, 'Number of found pages is not one.' );
|
||||
|
||||
// Test the second query's results match.
|
||||
$q2 = new WP_Query( $query_args );
|
||||
$this->assertEquals( $expected, $q2->posts, 'Posts property for second query is not in the expected form.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests querying all fields via WP_Query.
|
||||
*
|
||||
* @ticket 57012
|
||||
*/
|
||||
public function test_should_query_all_fields() {
|
||||
$query_args = array(
|
||||
'post_type' => 'wptests_pt',
|
||||
'fields' => 'all',
|
||||
);
|
||||
|
||||
$q = new WP_Query( $query_args );
|
||||
|
||||
$expected = array_map( 'get_post', array_reverse( self::$post_ids ) );
|
||||
|
||||
$this->assertEquals( $expected, $q->posts, 'Posts property for first query is not of expected form.' );
|
||||
$this->assertSame( 5, $q->found_posts, 'Number of found posts is not five.' );
|
||||
$this->assertEquals( 1, $q->max_num_pages, 'Number of found pages is not one.' );
|
||||
|
||||
// Test the second query's results match.
|
||||
$q2 = new WP_Query( $query_args );
|
||||
$this->assertEquals( $expected, $q2->posts, 'Posts property for second query is not in the expected form.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding fields to WP_Query via filters when requesting the ID and parent sub-set.
|
||||
*
|
||||
* @ticket 57012
|
||||
*/
|
||||
public function test_should_include_filtered_values_in_addition_to_id_and_parent_subset() {
|
||||
add_filter( 'posts_fields', array( $this, 'filter_posts_fields' ) );
|
||||
add_filter( 'posts_clauses', array( $this, 'filter_posts_clauses' ) );
|
||||
|
||||
$query_args = array(
|
||||
'post_type' => 'wptests_pt',
|
||||
'fields' => 'id=>parent',
|
||||
);
|
||||
|
||||
$q = new WP_Query( $query_args );
|
||||
|
||||
$expected = array();
|
||||
foreach ( self::$post_ids as $post_id ) {
|
||||
// Use array_shift to populate in the reverse order.
|
||||
array_unshift(
|
||||
$expected,
|
||||
(object) array(
|
||||
'ID' => $post_id,
|
||||
'post_parent' => 0,
|
||||
'test_post_fields' => 1,
|
||||
'test_post_clauses' => 2,
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$this->assertEquals( $expected, $q->posts, 'Posts property for first query is not of expected form.' );
|
||||
$this->assertSame( 5, $q->found_posts, 'Number of found posts is not five.' );
|
||||
$this->assertEquals( 1, $q->max_num_pages, 'Number of found pages is not one.' );
|
||||
|
||||
// Test the second query's results match.
|
||||
$q2 = new WP_Query( $query_args );
|
||||
$this->assertEquals( $expected, $q2->posts, 'Posts property for second query is not in the expected form.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding fields to WP_Query via filters when requesting the ID field.
|
||||
*
|
||||
* @ticket 57012
|
||||
*/
|
||||
public function test_should_include_filtered_values_in_addition_to_id() {
|
||||
add_filter( 'posts_fields', array( $this, 'filter_posts_fields' ) );
|
||||
add_filter( 'posts_clauses', array( $this, 'filter_posts_clauses' ) );
|
||||
|
||||
$query_args = array(
|
||||
'post_type' => 'wptests_pt',
|
||||
'fields' => 'ids',
|
||||
);
|
||||
|
||||
$q = new WP_Query( $query_args );
|
||||
|
||||
// Fields => ID does not include the additional fields.
|
||||
$expected = array_reverse( self::$post_ids );
|
||||
|
||||
$this->assertEquals( $expected, $q->posts, 'Posts property for first query is not of expected form.' );
|
||||
$this->assertSame( 5, $q->found_posts, 'Number of found posts is not five.' );
|
||||
$this->assertEquals( 1, $q->max_num_pages, 'Number of found pages is not one.' );
|
||||
|
||||
// Test the second query's results match.
|
||||
$q2 = new WP_Query( $query_args );
|
||||
$this->assertEquals( $expected, $q2->posts, 'Posts property for second query is not in the expected form.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding fields to WP_Query via filters when requesting all fields.
|
||||
*
|
||||
* @ticket 57012
|
||||
*/
|
||||
public function test_should_include_filtered_values() {
|
||||
add_filter( 'posts_fields', array( $this, 'filter_posts_fields' ) );
|
||||
add_filter( 'posts_clauses', array( $this, 'filter_posts_clauses' ) );
|
||||
|
||||
$query_args = array(
|
||||
'post_type' => 'wptests_pt',
|
||||
'fields' => 'all',
|
||||
);
|
||||
|
||||
$q = new WP_Query( $query_args );
|
||||
|
||||
$expected = array_map( 'get_post', array_reverse( self::$post_ids ) );
|
||||
foreach ( $expected as $post ) {
|
||||
$post->test_post_fields = 1;
|
||||
$post->test_post_clauses = 2;
|
||||
}
|
||||
|
||||
$this->assertEquals( $expected, $q->posts, 'Posts property for first query is not of expected form.' );
|
||||
$this->assertSame( 5, $q->found_posts, 'Number of found posts is not five.' );
|
||||
$this->assertEquals( 1, $q->max_num_pages, 'Number of found pages is not one.' );
|
||||
|
||||
// Test the second query's results match.
|
||||
$q2 = new WP_Query( $query_args );
|
||||
$this->assertEquals( $expected, $q2->posts, 'Posts property for second query is not in the expected form.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the posts fields.
|
||||
*
|
||||
* @param string $fields The fields to SELECT.
|
||||
* @return string The filtered fields.
|
||||
*/
|
||||
function filter_posts_fields( $fields ) {
|
||||
return "$fields, 1 as test_post_fields";
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters the posts clauses.
|
||||
*
|
||||
* @param array $clauses The WP_Query database clauses.
|
||||
* @return array The filtered database clauses.
|
||||
*/
|
||||
function filter_posts_clauses( $clauses ) {
|
||||
$clauses['fields'] .= ', 2 as test_post_clauses';
|
||||
return $clauses;
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user