<!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>[56555] trunk: Taxonomy: Cache term objects in WP_Term_Query if query is filtered.</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/56555">56555</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/56555","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-11 11:35:59 +0000 (Mon, 11 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'>Taxonomy: Cache term objects in WP_Term_Query if query is filtered.
When utilizing the `terms_clauses` or `get_terms_fields` filters within `WP_Term_Query` and the selected fields are modified, the entire term object is now cached. This adjustment is necessary because filters can broaden the selected fields beyond just the term ID. Fields linked to the term object, such as the count or parent, may undergo modifications when queried. Caching the complete object ensures the accurate storage of these modified fields within the cache.
Props spacedmonkey, tnolte, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/58116">#58116</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="#trunktestsphpunitteststermqueryphp">trunk/tests/phpunit/tests/term/query.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 2023-09-11 10:31:22 UTC (rev 56554)
+++ trunk/src/wp-includes/class-wp-term-query.php 2023-09-11 11:35:59 UTC (rev 56555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -738,6 +738,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $order = isset( $clauses['order'] ) ? $clauses['order'] : '';
</span><span class="cx" style="display: block; padding: 0 10px"> $limits = isset( $clauses['limits'] ) ? $clauses['limits'] : '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fields_is_filtered = implode( ', ', $selects ) !== $fields;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $where ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $where = "WHERE $where";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -782,7 +784,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cache = array_map( 'intval', $cache );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( 'count' !== $_fields ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ( 'all_with_object_id' === $_fields && ! empty( $args['object_ids'] ) )
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- || ( 'all' === $_fields && $args['pad_counts'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ || ( 'all' === $_fields && $args['pad_counts'] || $fields_is_filtered )
</ins><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $term_ids = wp_list_pluck( $cache, 'term_id' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -884,6 +886,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $object->count = $term->count;
</span><span class="cx" style="display: block; padding: 0 10px"> $term_cache[] = $object;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $fields_is_filtered ) {
+ $term_cache = $term_objects;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $term_cache = wp_list_pluck( $term_objects, 'term_id' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitteststermqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/query.php 2023-09-11 10:31:22 UTC (rev 56554)
+++ trunk/tests/phpunit/tests/term/query.php 2023-09-11 11:35:59 UTC (rev 56555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -699,6 +699,106 @@
</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">+ * If fields have filtered, cached results should work.
+ *
+ * @ticket 58116
+ * @group cache
+ */
+ public function test_query_filter_fields() {
+ $post_id = self::factory()->post->create();
+ register_taxonomy( 'wptests_tax', 'post' );
+
+ $term_id = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ )
+ );
+ wp_set_object_terms( $post_id, array( $term_id ), 'wptests_tax' );
+ $post_draft_id = self::factory()->post->create( array( 'post_type' => 'draft' ) );
+ wp_set_object_terms( $post_draft_id, array( $term_id ), 'wptests_tax' );
+
+ add_filter( 'terms_clauses', array( $this, 'filter_fields_terms_clauses' ), 10, 3 );
+
+ $args = array(
+ 'taxonomy' => 'wptests_tax',
+ 'hide_empty' => false,
+ 'post_type' => 'post',
+ 'post_status' => 'publish',
+ );
+
+ $q1 = new WP_Term_Query();
+ $terms1 = $q1->query( $args );
+ $q2 = new WP_Term_Query();
+ $terms2 = $q2->query( $args );
+ $this->assertSameSets( wp_list_pluck( $terms1, 'term_id' ), wp_list_pluck( $terms2, 'term_id' ), 'Term IDs are expected to match' );
+ $this->assertSameSets( wp_list_pluck( $terms1, 'count' ), wp_list_pluck( $terms2, 'count' ), 'Term counts are expected to match' );
+ }
+
+ /**
+ * Filter `terms_clauses` to change the field requested. The filter is from example code given in #58116.
+ */
+ public function filter_fields_terms_clauses( $clauses, $taxonomies, $args ) {
+ global $wpdb;
+
+ // Set to query specific posts types if set.
+ if ( ! empty( $args['post_type'] ) ) {
+ $clauses['fields'] = 'DISTINCT t.term_id, tt.term_taxonomy_id, tt.taxonomy, tt.description, tt.parent, COUNT(p.post_type) AS count';
+ $clauses['join'] .= ' LEFT JOIN ' . $wpdb->term_relationships . ' AS r ON r.term_taxonomy_id = tt.term_taxonomy_id LEFT JOIN ' . $wpdb->posts . ' AS p ON p.ID = r.object_id';
+ $clauses['where'] .= " AND (p.post_type = '" . $args['post_type'] . "' OR p.post_type IS NULL)";
+ $clauses['orderby'] = 'GROUP BY t.term_id ' . $clauses['orderby'];
+ }
+
+ // Set to query posts with specific status.
+ if ( ! empty( $args['post_status'] ) ) {
+ $clauses['where'] .= " AND (p.post_status = '" . $args['post_status'] . "')";
+ }
+ return $clauses;
+ }
+
+ /**
+ * If fields have filtered, cached results should work.
+ *
+ * @ticket 58116
+ * @group cache
+ */
+ public function test_query_filter_select_fields() {
+ $post_id = self::factory()->post->create();
+ register_taxonomy( 'wptests_tax', 'post' );
+
+ $term_id = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ )
+ );
+ wp_set_object_terms( $post_id, array( $term_id ), 'wptests_tax' );
+ $post_draft_id = self::factory()->post->create( array( 'post_type' => 'draft' ) );
+ wp_set_object_terms( $post_draft_id, array( $term_id ), 'wptests_tax' );
+
+ add_filter( 'get_terms_fields', array( $this, 'filter_get_terms_fields' ) );
+
+ $args = array(
+ 'taxonomy' => 'wptests_tax',
+ 'hide_empty' => false,
+ 'post_type' => 'post',
+ 'post_status' => 'publish',
+ );
+
+ $q1 = new WP_Term_Query();
+ $terms1 = $q1->query( $args );
+ $q2 = new WP_Term_Query();
+ $terms2 = $q2->query( $args );
+ $this->assertSameSets( wp_list_pluck( $terms1, 'term_id' ), wp_list_pluck( $terms2, 'term_id' ), 'Term IDs are expected to match' );
+ $this->assertSameSets( wp_list_pluck( $terms1, 'parent' ), wp_list_pluck( $terms2, 'parent' ), 'Term parent are expected to match' );
+ }
+
+ /**
+ * Filter `get_terms_fields` to change the field requested.
+ */
+ public function filter_get_terms_fields( $select ) {
+ return array( 't.term_id', 'tt.parent' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * The terms property should be an empty array for fields not as count and parent set.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 42327
</span></span></pre>
</div>
</div>
</body>
</html>