<!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>[56811] trunk: Query: Rename `_prime_post_parents_caches()` for clarity.</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/56811">56811</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/56811","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>2023-10-09 23:01:15 +0000 (Mon, 09 Oct 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: Rename `_prime_post_parents_caches()` for clarity.
Change the name of `_prime_post_parents_caches()` to `_prime_post_parent_id_caches()` to make it clearer only the parent post ID is cached rather than the entire post parent object.
Follow up to <a href="https://core.trac.wordpress.org/changeset/56763">[56763]</a>.
Props spacedmonkey, joemcgill, peterwilsoncc.
See <a href="https://core.trac.wordpress.org/ticket/59188">#59188</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="#trunktestsphpunittestspostprimePostParentsCachesphp">trunk/tests/phpunit/tests/post/primePostParentsCaches.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-10-09 23:00:11 UTC (rev 56810)
+++ trunk/src/wp-includes/class-wp-query.php 2023-10-09 23:01:15 UTC (rev 56811)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3191,7 +3191,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->posts;
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'id=>parent' === $q['fields'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( $post_ids );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( $post_ids );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** @var int[] */
</span><span class="cx" style="display: block; padding: 0 10px"> $post_parents = wp_cache_get_multiple( $post_ids, 'post_parent' );
</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 2023-10-09 23:00:11 UTC (rev 56810)
+++ trunk/src/wp-includes/post.php 2023-10-09 23:01:15 UTC (rev 56811)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7797,7 +7797,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Prime post parent caches.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prime the cache containing the parent ID of various post objects.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7805,7 +7805,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int[] $ids ID list.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function _prime_post_parents_caches( array $ids ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _prime_post_parent_id_caches( array $ids ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $non_cached_ids = _get_non_cached_ids( $ids, 'post_parent' );
</span></span></pre></div>
<a id="trunktestsphpunittestspostprimePostParentsCachesphp"></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/post/primePostParentsCaches.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/primePostParentsCaches.php 2023-10-09 23:00:11 UTC (rev 56810)
+++ trunk/tests/phpunit/tests/post/primePostParentsCaches.php 2023-10-09 23:01:15 UTC (rev 56811)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,19 +1,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Test `_prime_post_parents_caches()`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test `_prime_post_parent_id_caches()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @package WordPress
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Test class for `_prime_post_parents_caches()`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test class for `_prime_post_parent_id_caches()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @group post
</span><span class="cx" style="display: block; padding: 0 10px"> * @group 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">- * @covers ::_prime_post_parents_caches
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::_prime_post_parent_id_caches
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-class Tests_Post_PrimePostParentsCaches extends WP_UnitTestCase {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+class Tests_Post_PrimePostParentIdCaches extends WP_UnitTestCase {
</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"> * Post IDs.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,11 +34,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59188
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_prime_post_parents_caches() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_prime_post_parent_id_caches() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_id = self::$posts[0];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $before_num_queries = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( array( $post_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( array( $post_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries() - $before_num_queries;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $num_queries, 'Unexpected number of queries.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -48,9 +48,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59188
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_prime_post_parents_caches_multiple() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_prime_post_parent_id_caches_multiple() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $before_num_queries = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( self::$posts );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( self::$posts );
</ins><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries() - $before_num_queries;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $num_queries, 'Unexpected number of queries.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,10 +60,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59188
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_prime_post_parents_caches_multiple_runs() {
- _prime_post_parents_caches( self::$posts );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_prime_post_parent_id_caches_multiple_runs() {
+ _prime_post_parent_id_caches( self::$posts );
</ins><span class="cx" style="display: block; padding: 0 10px"> $before_num_queries = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( self::$posts );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( self::$posts );
</ins><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries() - $before_num_queries;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $num_queries, 'Unexpected number of queries.' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,7 +72,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59188
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_prime_post_parents_caches_update() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_prime_post_parent_id_caches_update() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $page_id = self::factory()->post->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_type' => 'page',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,7 +80,7 @@
</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"> $before_num_queries = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( array( $page_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( array( $page_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries() - $before_num_queries;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $num_queries, 'Unexpected number of queries on first run' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -94,7 +94,7 @@
</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"> $before_num_queries = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( array( $page_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( array( $page_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries() - $before_num_queries;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $num_queries, 'Unexpected number of queries on second run' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -104,7 +104,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 59188
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_prime_post_parents_caches_delete() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_prime_post_parent_id_caches_delete() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $parent_page_id = self::factory()->post->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_type' => 'page',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -117,7 +117,7 @@
</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"> $before_num_queries = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _prime_post_parents_caches( array( $page_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _prime_post_parent_id_caches( array( $page_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $num_queries = get_num_queries() - $before_num_queries;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $num_queries, 'Unexpected number of queries on first run' );
</span></span></pre>
</div>
</div>
</body>
</html>