<!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>[53037] trunk: Taxonomy: Improve performance by taxonomy queries by adding a limitting requested terms.</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/53037">53037</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/53037","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-03-31 10:04:25 +0000 (Thu, 31 Mar 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: Improve performance by taxonomy queries by adding a limitting requested terms.
Add a limit to the number of terms requested in taxonomy queries. This improves the performance of the query and the likelihood of hitting an existing term query cache.
Props Spacedmonkey, peterwilsoncc, flixos90.
Fixes <a href="https://core.trac.wordpress.org/ticket/55360">#55360</a>. </pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswptaxqueryphp">trunk/src/wp-includes/class-wp-tax-query.php</a></li>
<li><a href="#trunktestsphpunittestsquerytaxQueryphp">trunk/tests/phpunit/tests/query/taxQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswptaxqueryphp"></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-tax-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-tax-query.php 2022-03-31 09:07:02 UTC (rev 53036)
+++ trunk/src/wp-includes/class-wp-tax-query.php 2022-03-31 10:04:25 UTC (rev 53037)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -637,6 +637,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</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 ( ! is_taxonomy_hierarchical( $query['taxonomy'] ) ) {
+ $args['number'] = count( $terms );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $term_query = new WP_Term_Query();
</span><span class="cx" style="display: block; padding: 0 10px"> $term_list = $term_query->query( $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsquerytaxQueryphp"></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/taxQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/taxQuery.php 2022-03-31 09:07:02 UTC (rev 53036)
+++ trunk/tests/phpunit/tests/query/taxQuery.php 2022-03-31 10:04:25 UTC (rev 53037)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1621,4 +1621,124 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets( array( $p ), $q->posts );
</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 55360
+ *
+ * @covers WP_Tax_Query::transform_query
+ */
+ public function test_tax_terms_should_limit_query() {
+ $filter = new MockAction();
+ add_filter( 'terms_pre_query', array( $filter, 'filter' ), 10, 2 );
+ register_taxonomy( 'wptests_tax', 'post' );
+ $name = 'foobar';
+ $t = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'name' => $name,
+ )
+ );
+
+ $p = self::factory()->post->create();
+ wp_set_object_terms( $p, array( $t ), 'wptests_tax' );
+
+ $q = new WP_Query(
+ array(
+ 'fields' => 'ids',
+ 'tax_query' => array(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'field' => 'name',
+ 'terms' => $name,
+ ),
+ ),
+ )
+ );
+
+ $filter_args = $filter->get_args();
+ $query = $filter_args[1][1]->request;
+
+ $this->assertSameSets( array( $p ), $q->posts );
+ $this->assertStringContainsString( 'LIMIT 1', $query );
+ }
+
+ /**
+ * @ticket 55360
+ *
+ * @covers WP_Tax_Query::transform_query
+ */
+ public function test_tax_terms_should_limit_query_to_one() {
+ $filter = new MockAction();
+ add_filter( 'terms_pre_query', array( $filter, 'filter' ), 10, 2 );
+ register_taxonomy( 'wptests_tax', 'post' );
+ $name = 'foobar';
+ $t = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'name' => $name,
+ )
+ );
+
+ $p = self::factory()->post->create();
+ wp_set_object_terms( $p, array( $t ), 'wptests_tax' );
+
+ $q = new WP_Query(
+ array(
+ 'fields' => 'ids',
+ 'tax_query' => array(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'field' => 'term_id',
+ 'terms' => array( $t, $t, $t ),
+ ),
+ ),
+ )
+ );
+
+ $filter_args = $filter->get_args();
+ $query = $filter_args[1][1]->request;
+
+ $this->assertSameSets( array( $p ), $q->posts );
+ $this->assertStringContainsString( 'LIMIT 1', $query );
+ }
+
+ /**
+ * @ticket 55360
+ *
+ * @covers WP_Tax_Query::transform_query
+ */
+ public function test_hierarchical_taxonomies_do_not_limit_query() {
+ $filter = new MockAction();
+ add_filter( 'terms_pre_query', array( $filter, 'filter' ), 10, 2 );
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+ $name = 'foobar';
+ $t = self::factory()->term->create(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'name' => $name,
+ )
+ );
+
+ $p = self::factory()->post->create();
+ wp_set_object_terms( $p, array( $t ), 'wptests_tax' );
+
+ $q = new WP_Query(
+ array(
+ 'fields' => 'ids',
+ 'tax_query' => array(
+ array(
+ 'taxonomy' => 'wptests_tax',
+ 'field' => 'name',
+ 'terms' => $name,
+ ),
+ ),
+ )
+ );
+
+ $filter_args = $filter->get_args();
+ $query = $filter_args[0][1]->request;
+
+ $this->assertSameSets( array( $p ), $q->posts );
+ $this->assertStringNotContainsString( 'LIMIT 1', $query );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>