<!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>[59919] trunk: Query: Ensure secondary loops populate the full global post.</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/59919">59919</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/59919","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-03-03 21:43:44 +0000 (Mon, 03 Mar 2025)</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: Ensure secondary loops populate the full global post.
Modifies `WP_Query::the_post()` to ensure the entire global post object is populated regardless of the `fields` parameter initially set by the developer.
In secondary loops, this ensures that `get_the_content()` and other getter functions operate as documented when called without a post ID and return the appropriate data for the global post object.
This introduces consistency when starting the loop and the `fields` parameter is set to `id=>parent` to the behaviour when set to either `all` or `ids`.
There is no change to the `WP_Query::$posts` parameter nor when a query is made without starting the secondary loop, ie without calling `WP_Query::the_post()`.
Props juzar, mukesh27, oglekler, peterwilsoncc, sirlouen, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/56992">#56992</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>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsquerythePostphp">trunk/tests/phpunit/tests/query/thePost.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 2025-03-03 21:29:54 UTC (rev 59918)
+++ trunk/src/wp-includes/class-wp-query.php 2025-03-03 21:43:44 UTC (rev 59919)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3738,14 +3738,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $post;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->in_the_loop ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Only prime the post cache for queries limited to the ID field.
- $post_ids = array_filter( $this->posts, 'is_numeric' );
- // Exclude any falsey values, such as 0.
- $post_ids = array_filter( $post_ids );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Get post IDs to prime incomplete post objects.
+ $post_ids = array_reduce(
+ $this->posts,
+ function ( $carry, $post ) {
+ if ( is_numeric( $post ) && $post > 0 ) {
+ // Query for post ID.
+ $carry[] = $post;
+ }
+
+ if ( is_object( $post ) && isset( $post->ID ) ) {
+ // Query for object, either WP_Post or stdClass.
+ $carry[] = $post->ID;
+ }
+
+ return $carry;
+ },
+ array()
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $post_ids ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _prime_post_caches( $post_ids, $this->query_vars['update_post_term_cache'], $this->query_vars['update_post_meta_cache'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $post_objects = array_map( 'get_post', $this->posts );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_objects = array_map( 'get_post', $post_ids );
</ins><span class="cx" style="display: block; padding: 0 10px"> update_post_author_caches( $post_objects );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3764,6 +3778,16 @@
</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"> $post = $this->next_post();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Get the post ID.
+ if ( is_object( $post ) ) {
+ $global_post_id = $post->ID;
+ } else {
+ $global_post_id = $post;
+ }
+
+ // Ensure the global $post is the full post object.
+ $post = get_post( $global_post_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->setup_postdata( $post );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</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 2025-03-03 21:29:54 UTC (rev 59918)
+++ trunk/tests/phpunit/tests/query/cacheResults.php 2025-03-03 21:43:44 UTC (rev 59919)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1925,6 +1925,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.1
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 56948
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 56992
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Query::the_post
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1978,13 +1979,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function data_author_cache_warmed_by_the_loop() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fields: empty' => array( '' ),
- 'fields: all' => array( 'all' ),
- 'fields: ids' => array( 'ids' ),
- /*
- * `id=>parent` is untested pending the resolution of an existing bug.
- * See https://core.trac.wordpress.org/ticket/56992
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fields: empty' => array( '' ),
+ 'fields: all' => array( 'all' ),
+ 'fields: ids' => array( 'ids' ),
+ 'fields: id=>parent' => array( 'id=>parent' ),
</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">
</span></span></pre></div>
<a id="trunktestsphpunittestsquerythePostphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/query/thePost.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/thePost.php (rev 0)
+++ trunk/tests/phpunit/tests/query/thePost.php 2025-03-03 21:43:44 UTC (rev 59919)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,194 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group query
+ * @covers WP_Query::the_post
+ */
+class Tests_Query_ThePost extends WP_UnitTestCase {
+
+ /**
+ * Author IDs created for shared fixtures.
+ *
+ * @var int[]
+ */
+ public static $author_ids = array();
+
+ /**
+ * Post parent ID created for shared fixtures.
+ *
+ * @var int
+ */
+ public static $page_parent_id = 0;
+
+ /**
+ * Post child IDs created for shared fixtures.
+ *
+ * @var int[]
+ */
+ public static $page_child_ids = array();
+
+ /**
+ * Create the shared fixtures.
+ *
+ * @param WP_UnitTest_Factory $factory Factory object.
+ */
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ self::$author_ids = $factory->user->create_many( 5, array( 'role' => 'author' ) );
+ self::$page_parent_id = $factory->post->create( array( 'post_type' => 'page' ) );
+
+ // Create child pages.
+ foreach ( self::$author_ids as $author_id ) {
+ self::$page_child_ids[] = $factory->post->create(
+ array(
+ 'post_type' => 'page',
+ 'post_parent' => self::$page_parent_id,
+ 'post_author' => $author_id,
+ )
+ );
+ }
+ }
+
+ /**
+ * Ensure that a secondary loop populates the global post completely regardless of the fields parameter.
+ *
+ * @ticket 56992
+ *
+ * @dataProvider data_the_loop_fields
+ *
+ * @param string $fields Fields parameter for use in the query.
+ */
+ public function test_the_loop_populates_the_global_post_completely( $fields ) {
+ $query = new WP_Query(
+ array(
+ 'fields' => $fields,
+ 'post_type' => 'page',
+ 'page_id' => self::$page_child_ids[0],
+ )
+ );
+
+ $this->assertNotEmpty( $query->posts, 'The query is expected to return results' );
+
+ // Start the loop.
+ $query->the_post();
+
+ // Get the global post and specific post.
+ $global_post = get_post();
+ $specific_post = get_post( self::$page_child_ids[0], ARRAY_A );
+
+ $this->assertNotEmpty( get_the_title(), 'The title is expected to be populated.' );
+ $this->assertNotEmpty( get_the_content(), 'The content is expected to be populated.' );
+ $this->assertNotEmpty( get_the_excerpt(), 'The excerpt is expected to be populated.' );
+
+ $this->assertSameSetsWithIndex( $specific_post, $global_post->to_array(), 'The global post is expected to be fully populated.' );
+ }
+
+ /**
+ * Ensure that a secondary loop primes the post cache completely regardless of the fields parameter.
+ *
+ * @ticket 56992
+ *
+ * @dataProvider data_the_loop_fields
+ *
+ * @param string $fields Fields parameter for use in the query.
+ * @param int $expected_queries Expected number of queries when starting the loop.
+ */
+ public function test_the_loop_primes_the_post_cache( $fields, $expected_queries ) {
+ $query = new WP_Query(
+ array(
+ 'fields' => $fields,
+ 'post_type' => 'page',
+ 'post__in' => self::$page_child_ids,
+ )
+ );
+
+ // Start the loop.
+ $start_queries = get_num_queries();
+ $query->the_post();
+ $end_queries = get_num_queries();
+ /*
+ * Querying complete posts: 2 queries.
+ * 1. User meta data.
+ * 2. User data.
+ *
+ * Querying partial posts: 4 queries.
+ * 1. Post objects
+ * 2. Post meta data.
+ * 3. User meta data.
+ * 4. User data.
+ */
+ $this->assertSame( $expected_queries, $end_queries - $start_queries, "Starting the loop should make $expected_queries db queries." );
+
+ // Complete the loop.
+ $start_queries = get_num_queries();
+ while ( $query->have_posts() ) {
+ $query->the_post();
+ }
+ $end_queries = get_num_queries();
+
+ $this->assertSame( 0, $end_queries - $start_queries, 'The cache is expected to be primed by the loop.' );
+ }
+
+ /**
+ * Ensure that a secondary loop primes the author cache completely regardless of the fields parameter.
+ *
+ * @ticket 56992
+ *
+ * @dataProvider data_the_loop_fields
+ *
+ * @param string $fields Fields parameter for use in the query.
+ * @param int $expected_queries Expected number of queries when starting the loop.
+ */
+ public function test_the_loop_primes_the_author_cache( $fields, $expected_queries ) {
+ $query = new WP_Query(
+ array(
+ 'fields' => $fields,
+ 'post_type' => 'page',
+ 'post__in' => self::$page_child_ids,
+ )
+ );
+
+ // Start the loop.
+ $start_queries = get_num_queries();
+ $query->the_post();
+ $end_queries = get_num_queries();
+ /*
+ * Querying complete posts: 2 queries.
+ * 1. User meta data.
+ * 2. User data.
+ *
+ * Querying partial posts: 4 queries.
+ * 1. Post objects
+ * 2. Post meta data.
+ * 3. User meta data.
+ * 4. User data.
+ */
+ $this->assertSame( $expected_queries, $end_queries - $start_queries, "Starting the loop should make $expected_queries db queries." );
+
+ // Complete the loop.
+ $start_queries = get_num_queries();
+ while ( $query->have_posts() ) {
+ $query->the_post();
+ get_the_author();
+ }
+ $end_queries = get_num_queries();
+
+ $this->assertSame( 0, $end_queries - $start_queries, 'The cache is expected to be primed by the loop.' );
+ }
+
+ /**
+ * Data provider for:
+ * - test_the_loop_populates_the_global_post_completely,
+ * - test_the_loop_primes_the_post_cache, and,
+ * - test_the_loop_primes_the_author_cache.
+ *
+ * @return array[]
+ */
+ public function data_the_loop_fields() {
+ return array(
+ 'all fields' => array( 'all', 2 ),
+ 'all fields (empty fields)' => array( '', 2 ),
+ 'post IDs' => array( 'ids', 4 ),
+ 'post ids and parent' => array( 'id=>parent', 4 ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/query/thePost.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>