<!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>[54771] trunk: Query: Prevent ID only queries erroring when starting the loop.</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/54771">54771</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/54771","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>2022-11-09 00:57:02 +0000 (Wed, 09 Nov 2022)</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: Prevent ID only queries erroring when starting the loop.
Ensure only full post objects are passed to `update_post_author_caches()` when called within `WP_Query::the_post()`. This prevents an error when starting the Loop for Queries initiated with a subset of fields or IDs only.
Props konyoldeath, dd32, lozula, TimothyBlynJacobs, spacedmonkey, mxbclang, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/56948">#56948</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.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 2022-11-09 00:38:14 UTC (rev 54770)
+++ trunk/src/wp-includes/class-wp-query.php 2022-11-09 00:57:02 UTC (rev 54771)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3586,7 +3586,15 @@
</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">- update_post_author_caches( $this->posts );
</del><ins style="background-color: #dfd; 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 );
+ if ( $post_ids ) {
+ _prime_post_caches( $post_ids, $this->query_vars['update_post_term_cache'], $this->query_vars['update_post_meta_cache'] );
+ }
+ $post_objects = array_map( 'get_post', $this->posts );
+ update_post_author_caches( $post_objects );
</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"> $this->in_the_loop = true;
</span></span></pre></div>
<a id="trunksrcwpincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2022-11-09 00:38:14 UTC (rev 54770)
+++ trunk/src/wp-includes/post.php 2022-11-09 00:57:02 UTC (rev 54771)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7461,6 +7461,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post[] $posts Array of post objects.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function update_post_author_caches( $posts ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * cache_users() is a pluggable function so is not available prior
+ * to the `plugins_loaded` hook firing. This is to ensure against
+ * fatal errors when the function is not available.
+ */
+ if ( ! function_exists( 'cache_users' ) ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $author_ids = wp_list_pluck( $posts, 'post_author' );
</span><span class="cx" style="display: block; padding: 0 10px"> $author_ids = array_map( 'absint', $author_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> $author_ids = array_unique( array_filter( $author_ids ) );
</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 2022-11-09 00:38:14 UTC (rev 54770)
+++ trunk/tests/phpunit/tests/query/cacheResults.php 2022-11-09 00:57:02 UTC (rev 54771)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1210,4 +1210,65 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'id=>parent', 'id=>parent' ),
</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">+
+ /**
+ * Ensure starting the loop warms the author cache.
+ *
+ * @since 6.1.1
+ * @ticket 56948
+ *
+ * @covers WP_Query::the_post
+ *
+ * @dataProvider data_author_cache_warmed_by_the_loop
+ *
+ * @param string $fields Query fields.
+ */
+ public function test_author_cache_warmed_by_the_loop( $fields ) {
+ // Update post author for the parent post.
+ self::factory()->post->update_object( self::$pages[0], array( 'post_author' => self::$author_id ) );
+
+ self::factory()->post->create(
+ array(
+ 'post_author' => self::$author_id,
+ 'post_parent' => self::$pages[0],
+ 'post_type' => 'page',
+ )
+ );
+
+ $query_1 = new WP_Query(
+ array(
+ 'post_type' => 'page',
+ 'fields' => $fields,
+ 'author' => self::$author_id,
+ )
+ );
+
+ // Start the loop.
+ $start_loop_queries = get_num_queries();
+ $query_1->the_post();
+ $num_loop_queries = get_num_queries() - $start_loop_queries;
+ $this->assertSame( 2, $num_loop_queries, 'Unexpected number of queries while initializing the loop.' );
+
+ $start_author_queries = get_num_queries();
+ get_user_by( 'ID', self::$author_id );
+ $num_author_queries = get_num_queries() - $start_author_queries;
+ $this->assertSame( 0, $num_author_queries, 'Author cache is not warmed by the loop.' );
+ }
+
+ /**
+ * Data provider for test_author_cache_warmed_by_the_loop
+ *
+ * @return array[]
+ */
+ public function data_author_cache_warmed_by_the_loop() {
+ return array(
+ '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
+ */
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>