<!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>[53496] trunk: Taxonomy: Fix caching issues in `WP_Term_Query` class.</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/53496">53496</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/53496","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>2022-06-14 11:41:33 +0000 (Tue, 14 Jun 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'>Taxonomy: Fix caching issues in `WP_Term_Query` class.
Introduced <a href="https://core.trac.wordpress.org/changeset/52836">[52836]</a> when passing `child_of` or `pad_counts` parameters to `get_terms` or `WP_Term_Query` class, the array of terms received by the query, was not correctly cached. This
change simplifies the logic in `WP_Term_Query` and ensures terms are correctly cached. This change also, improves performance, by only caching an array of term ids where possible.
Props denishua, spacedmonkey, oztaser, peterwilsoncc, SergeyBiryukov, georgestephanis, jnz31, knutsp, mukesh27, costdev.
Fixes <a href="https://core.trac.wordpress.org/ticket/55837">#55837</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswptermqueryphp">trunk/src/wp-includes/class-wp-term-query.php</a></li>
<li><a href="#trunksrcwpincludesversionphp">trunk/src/wp-includes/version.php</a></li>
<li><a href="#trunktestsphpunitteststermgetTermsphp">trunk/tests/phpunit/tests/term/getTerms.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswptermqueryphp"></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-term-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-term-query.php 2022-06-13 16:42:17 UTC (rev 53495)
+++ trunk/src/wp-includes/class-wp-term-query.php 2022-06-14 11:41:33 UTC (rev 53496)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -770,7 +770,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // $args can be anything. Only use the args defined in defaults to compute the key.
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_args = wp_array_slice_assoc( $args, array_keys( $this->query_var_defaults ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $cache_args['pad_counts'], $cache_args['update_term_meta_cache'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $cache_args['update_term_meta_cache'] );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'count' !== $_fields && 'all_with_object_id' !== $_fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cache_args['fields'] = 'all';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -783,10 +783,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $cache ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'ids' === $_fields ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $term_ids = wp_list_pluck( $cache, 'term_id' );
- $cache = array_map( 'intval', $term_ids );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cache = array_map( 'intval', $cache );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'count' !== $_fields ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $term_ids = wp_list_pluck( $cache, 'term_id' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) ) || ( 'all' === $_fields && $args['pad_counts'] ) ) {
+ $term_ids = wp_list_pluck( $cache, 'term_id' );
+ } else {
+ $term_ids = array_map( 'intval', $cache );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> _prime_term_caches( $term_ids, $args['update_term_meta_cache'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $term_objects = $this->populate_terms( $cache );
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = $this->format_terms( $term_objects, $_fields );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -849,34 +852,11 @@
</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">- /*
- * When querying for terms connected to objects, we may get
- * duplicate results. The duplicates should be preserved if
- * `$fields` is 'all_with_object_id', but should otherwise be
- * removed.
- */
- if ( ! empty( $args['object_ids'] ) && 'all_with_object_id' !== $_fields ) {
- $_tt_ids = array();
- $_terms = array();
- foreach ( $terms as $term ) {
- if ( isset( $_tt_ids[ $term->term_id ] ) ) {
- continue;
- }
-
- $_tt_ids[ $term->term_id ] = 1;
- $_terms[] = $term;
- }
-
- $terms = $_terms;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Hierarchical queries are not limited, so 'offset' and 'number' must be handled now.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $hierarchical && $number && is_array( $terms ) ) {
- if ( $offset >= count( $terms ) ) {
- $terms = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $hierarchical && $number && is_array( $term_objects ) ) {
+ if ( $offset >= count( $term_objects ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $term_objects = array();
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $terms = array_slice( $terms, $offset, $number, true );
</del><span class="cx" style="display: block; padding: 0 10px"> $term_objects = array_slice( $term_objects, $offset, $number, true );
</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">@@ -887,10 +867,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> update_termmeta_cache( $term_ids );
</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">- wp_cache_add( $cache_key, $terms, 'terms' );
- $terms = $this->format_terms( $term_objects, $_fields );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) ) {
+ $term_cache = array();
+ foreach ( $term_objects as $term ) {
+ $object = new stdClass();
+ $object->term_id = $term->term_id;
+ $object->object_id = $term->object_id;
+ $term_cache[] = $object;
+ }
+ } elseif ( 'all' === $_fields && $args['pad_counts'] ) {
+ $term_cache = array();
+ foreach ( $term_objects as $term ) {
+ $object = new stdClass();
+ $object->term_id = $term->term_id;
+ $object->count = $term->count;
+ $term_cache[] = $object;
+ }
+ } else {
+ $term_cache = wp_list_pluck( $term_objects, 'term_id' );
+ }
+ wp_cache_add( $cache_key, $term_cache, 'terms' );
+ $this->terms = $this->format_terms( $term_objects, $_fields );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->terms = $terms;
</del><span class="cx" style="display: block; padding: 0 10px"> return $this->terms;
</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">@@ -1119,6 +1117,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( property_exists( $term_data, 'object_id' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $term->object_id = (int) $term_data->object_id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( property_exists( $term_data, 'count' ) ) {
+ $term->count = (int) $term_data->count;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $term = get_term( $term_data );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesversionphp"></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/version.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/version.php 2022-06-13 16:42:17 UTC (rev 53495)
+++ trunk/src/wp-includes/version.php 2022-06-14 11:41:33 UTC (rev 53496)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +23,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $wp_db_version
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$wp_db_version = 51917;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$wp_db_version = 53496;
</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"> * Holds the TinyMCE version.
</span></span></pre></div>
<a id="trunktestsphpunitteststermgetTermsphp"></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/term/getTerms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTerms.php 2022-06-13 16:42:17 UTC (rev 53495)
+++ trunk/tests/phpunit/tests/term/getTerms.php 2022-06-14 11:41:33 UTC (rev 53496)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -747,6 +747,27 @@
</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 55837
+ * @covers ::get_terms
+ */
+ public function test_get_terms_child_of_cache() {
+ $parent = self::factory()->category->create();
+ self::factory()->category->create( array( 'parent' => $parent ) );
+
+ $args = array(
+ 'fields' => 'ids',
+ 'child_of' => $parent,
+ 'hide_empty' => false,
+ );
+ $terms = get_terms( 'category', $args );
+ $this->assertCount( 1, $terms, 'The first call to get_terms() did not return 1 term' );
+
+ $terms2 = get_terms( 'category', $args );
+ $this->assertCount( 1, $terms2, 'The second call to get_terms() did not return 1 term' );
+ $this->assertSameSets( $terms, $terms2, 'Results are not the same after caching' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 46768
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_terms_child_of_fields_id_name() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2590,6 +2611,76 @@
</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 55837
+ * @covers ::get_terms
+ */
+ public function test_pad_counts_cached() {
+ register_taxonomy( 'wptests_tax_1', 'post', array( 'hierarchical' => true ) );
+
+ $posts = self::factory()->post->create_many( 3 );
+
+ $t1 = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax_1',
+ )
+ );
+ $t2 = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax_1',
+ 'parent' => $t1,
+ )
+ );
+ $t3 = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax_1',
+ 'parent' => $t2,
+ )
+ );
+
+ wp_set_object_terms( $posts[0], array( $t1 ), 'wptests_tax_1' );
+ wp_set_object_terms( $posts[1], array( $t2 ), 'wptests_tax_1' );
+ wp_set_object_terms( $posts[2], array( $t3 ), 'wptests_tax_1' );
+
+ $found = get_terms(
+ 'wptests_tax_1',
+ array(
+ 'pad_counts' => true,
+ )
+ );
+
+ $this->assertSameSets( array( $t1, $t2, $t3 ), wp_list_pluck( $found, 'term_id' ), 'Check to see if results are as expected' );
+
+ foreach ( $found as $f ) {
+ if ( $t1 === $f->term_id ) {
+ $this->assertSame( 3, $f->count, 'Check to see if term 1, has the correct count' );
+ } elseif ( $t2 === $f->term_id ) {
+ $this->assertSame( 2, $f->count, 'Check to see if term 2, has the correct count' );
+ } else {
+ $this->assertSame( 1, $f->count, 'Check to see if term 3, has the correct count' );
+ }
+ }
+
+ $found = get_terms(
+ 'wptests_tax_1',
+ array(
+ 'pad_counts' => true,
+ )
+ );
+
+ $this->assertSameSets( array( $t1, $t2, $t3 ), wp_list_pluck( $found, 'term_id' ), 'Check to see if results are as expected on second run' );
+
+ foreach ( $found as $f ) {
+ if ( $t1 === $f->term_id ) {
+ $this->assertSame( 3, $f->count, 'Check to see if term 1, has the correct count on second run' );
+ } elseif ( $t2 === $f->term_id ) {
+ $this->assertSame( 2, $f->count, 'Check to see if term 2, has the correct count on second run' );
+ } else {
+ $this->assertSame( 1, $f->count, 'Check to see if term 3, has the correct count on second run' );
+ }
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 20635
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_pad_counts_should_not_recurse_infinitely_when_term_hierarchy_has_a_loop() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3099,17 +3190,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => 'slugs',
</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">- 'meta cache off, pad count on vs meta cache on, pad count off' => array(
- array(
- 'taxonomy' => self::$taxonomy,
- 'pad_counts' => true,
- 'update_term_meta_cache' => false,
- ),
- array(
- 'taxonomy' => self::$taxonomy,
- 'fields' => 'ids',
- ),
- ),
</del><span class="cx" style="display: block; padding: 0 10px"> 'array slug vs string slug' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'taxonomy' => self::$taxonomy,
</span></span></pre>
</div>
</div>
</body>
</html>