<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56656] trunk: Query: Improved handling of filtered queries in WP_Query.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56656">56656</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56656","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-21 19:32:55 +0000 (Thu, 21 Sep 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/58599">#58599</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
<li><a href="#trunktestsphpunittestsquerycacheResultsphp">trunk/tests/phpunit/tests/query/cacheResults.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php 2023-09-21 18:27:17 UTC (rev 56655)
+++ trunk/src/wp-includes/class-wp-query.php 2023-09-21 19:32:55 UTC (rev 56656)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3270,10 +3270,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $post_parents;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $is_unfiltered_query = $old_request == $this->request && "{$wpdb->posts}.*" === $fields;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( null === $this->posts ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $split_the_query = (
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $old_request == $this->request
- && "{$wpdb->posts}.*" === $fields
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $is_unfiltered_query
</ins><span class="cx" style="display: block; padding: 0 10px"> && (
</span><span class="cx" style="display: block; padding: 0 10px"> wp_using_ext_object_cache()
</span><span class="cx" style="display: block; padding: 0 10px"> || ( ! empty( $limits ) && $q['posts_per_page'] < 500 )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3337,6 +3338,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array_map( 'get_post', $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unfiltered_posts = $this->posts;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $q['cache_results'] && $id_query_is_cacheable && ! $cache_found ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_ids = wp_list_pluck( $this->posts, 'ID' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3529,7 +3532,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->posts = array_map( 'get_post', $this->posts );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $q['cache_results'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_post_caches( $this->posts, $post_type, $q['update_post_term_cache'], $q['update_post_meta_cache'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $is_unfiltered_query && $unfiltered_posts === $this->posts ) {
+ update_post_caches( $this->posts, $post_type, $q['update_post_term_cache'], $q['update_post_meta_cache'] );
+ } else {
+ $post_ids = wp_list_pluck( $this->posts, 'ID' );
+ _prime_post_caches( $post_ids, $q['update_post_term_cache'], $q['update_post_meta_cache'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** @var WP_Post */
</span></span></pre></div>
<a id="trunktestsphpunittestsquerycacheResultsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/query/cacheResults.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/cacheResults.php 2023-09-21 18:27:17 UTC (rev 56655)
+++ trunk/tests/phpunit/tests/query/cacheResults.php 2023-09-21 19:32:55 UTC (rev 56656)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1080,6 +1080,85 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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' ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 22176
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_query_cache_should_exclude_post_with_excluded_term() {
</span></span></pre>
</div>
</div>
</body>
</html>