<!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>[40918] trunk: Use `WP_Term_Query` when transforming tax queries.</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 { 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/40918">40918</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/40918","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-06-21 03:56:25 +0000 (Wed, 21 Jun 2017)</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'>Use `WP_Term_Query` when transforming tax queries.
This change allows tax query transformations to be cached.
Props spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/37038">#37038</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="#trunktestsphpunitteststermtaxQueryphp">trunk/tests/phpunit/tests/term/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 2017-06-20 18:27:53 UTC (rev 40917)
+++ trunk/src/wp-includes/class-wp-tax-query.php 2017-06-21 03:56:25 UTC (rev 40918)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -595,6 +595,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Transforms a single query, from one field to another.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Operates on the `$query` object by reference. In the case of error,
+ * `$query` is converted to a WP_Error object.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb The WordPress database abstraction object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -604,8 +607,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or 'term_id'. Default 'term_id'.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function transform_query( &$query, $resulting_field ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wpdb;
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $query['terms'] ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -614,57 +615,52 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $resulting_field = sanitize_key( $resulting_field );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Empty 'terms' always results in a null transformation.
+ $terms = array_filter( $query['terms'] );
+ if ( empty( $terms ) ) {
+ $query['terms'] = array();
+ $query['field'] = $resulting_field;
+ return;
+ }
+
+ $args = array(
+ 'get' => 'all',
+ 'number' => 0,
+ 'taxonomy' => $query['taxonomy'],
+ 'update_term_meta_cache' => false,
+ 'orderby' => 'none',
+ );
+
+ // Term query parameter name depends on the 'field' being searched on.
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $query['field'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'slug':
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['slug'] = $terms;
+ break;
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'name':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $query['terms'] as &$term ) {
- /*
- * 0 is the $term_id parameter. We don't have a term ID yet, but it doesn't
- * matter because `sanitize_term_field()` ignores the $term_id param when the
- * context is 'db'.
- */
- $clean_term = sanitize_term_field( $query['field'], $term, 0, $query['taxonomy'], 'db' );
-
- // Match sanitization in wp_insert_term().
- $clean_term = wp_unslash( $clean_term );
-
- $term = "'" . esc_sql( $clean_term ) . "'";
- }
-
- $terms = implode( ",", $query['terms'] );
-
- $terms = $wpdb->get_col( "
- SELECT $wpdb->term_taxonomy.$resulting_field
- FROM $wpdb->term_taxonomy
- INNER JOIN $wpdb->terms USING (term_id)
- WHERE taxonomy = '{$query['taxonomy']}'
- AND $wpdb->terms.{$query['field']} IN ($terms)
- " );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['name'] = $terms;
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'term_taxonomy_id':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $terms = implode( ',', array_map( 'intval', $query['terms'] ) );
- $terms = $wpdb->get_col( "
- SELECT $resulting_field
- FROM $wpdb->term_taxonomy
- WHERE term_taxonomy_id IN ($terms)
- " );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['term_taxonomy_id'] = $terms;
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> default:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $terms = implode( ',', array_map( 'intval', $query['terms'] ) );
- $terms = $wpdb->get_col( "
- SELECT $resulting_field
- FROM $wpdb->term_taxonomy
- WHERE taxonomy = '{$query['taxonomy']}'
- AND term_id IN ($terms)
- " );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['include'] = wp_parse_id_list( $terms );
+ break;
</ins><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">- if ( 'AND' == $query['operator'] && count( $terms ) < count( $query['terms'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $term_query = new WP_Term_Query();
+ $term_list = $term_query->query( $args );
+
+ if ( is_wp_error( $term_list ) ) {
+ $query = $term_list;
+ return;
+ }
+
+ if ( 'AND' == $query['operator'] && count( $term_list ) < count( $query['terms'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $query = new WP_Error( 'inexistent_terms', __( 'Inexistent terms.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- $query['terms'] = $terms;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query['terms'] = wp_list_pluck( $term_list, $resulting_field );
</ins><span class="cx" style="display: block; padding: 0 10px"> $query['field'] = $resulting_field;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunitteststermtaxQueryphp"></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/taxQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/taxQuery.php 2017-06-20 18:27:53 UTC (rev 40917)
+++ trunk/tests/phpunit/tests/term/taxQuery.php 2017-06-21 03:56:25 UTC (rev 40918)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,7 +163,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $tq->transform_query( $tq->queries[0], 'term_taxonomy_id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( $tt_ids, $tq->queries[0]['terms'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( $tt_ids, $tq->queries[0]['terms'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'term_taxonomy_id', $tq->queries[0]['field'] );
</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">@@ -181,7 +181,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $tq->transform_query( $tq->queries[0], 'term_taxonomy_id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( $tt_ids, $tq->queries[0]['terms'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEqualSets( $tt_ids, $tq->queries[0]['terms'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'term_taxonomy_id', $tq->queries[0]['field'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>