<!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>[40293] trunk: Improve querying for terms with falsey names and slugs.</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/40293">40293</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/40293","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-03-16 02:03:53 +0000 (Thu, 16 Mar 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'>Improve querying for terms with falsey names and slugs.
Prior to <a href="https://core.trac.wordpress.org/changeset/38677">[38677]</a>, `get_term_by()` would always return false if
an empty string were passed as the queried 'name' or 'slug'. The
refactor to use `get_terms()` broke this behavior; inappropriately
imprecise `empty()` checks caused the 'name' or 'slug' clause to be
discarded altogether when fetching terms, resulting in an incorrect
term being returned from the function.
We fix the regression by special-casing truly empty values passed
to `get_term_by()`, and ensuring that `WP_Term_Query` is properly
able to handle `0` and `'0'` term queries.
Props sstoqnov.
Fixes <a href="https://core.trac.wordpress.org/ticket/21760">#21760</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="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.php</a></li>
<li><a href="#trunktestsphpunitteststermgetTermByphp">trunk/tests/phpunit/tests/term/getTermBy.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 2017-03-16 01:34:52 UTC (rev 40292)
+++ trunk/src/wp-includes/class-wp-term-query.php 2017-03-16 02:03:53 UTC (rev 40293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -474,7 +474,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->sql_clauses['where']['exclusions'] = preg_replace( '/^\s*AND\s*/', '', $exclusions );
</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">- if ( ! empty( $args['name'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ( ! empty( $args['name'] ) ) ||
+ ( is_string( $args['name'] ) && 0 !== strlen( $args['name'] ) )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $names = (array) $args['name'];
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $names as &$_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // `sanitize_term_field()` returns slashed data.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,7 +487,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->sql_clauses['where']['name'] = "t.name IN ('" . implode( "', '", array_map( 'esc_sql', $names ) ) . "')";
</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">- if ( ! empty( $args['slug'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ( ! empty( $args['slug'] ) ) ||
+ ( is_string( $args['slug'] ) && 0 !== strlen( $args['slug'] ) )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $args['slug'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $slug = array_map( 'sanitize_title', $args['slug'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->sql_clauses['where']['slug'] = "t.slug IN ('" . implode( "', '", $slug ) . "')";
</span></span></pre></div>
<a id="trunksrcwpincludestaxonomyphp"></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/taxonomy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/taxonomy.php 2017-03-16 01:34:52 UTC (rev 40292)
+++ trunk/src/wp-includes/taxonomy.php 2017-03-16 02:03:53 UTC (rev 40293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -835,6 +835,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">+ // No need to perform a query for empty 'slug' or 'name'.
+ if ( 'slug' === $field || 'name' === $field ) {
+ $value = (string) $value;
+
+ if ( 0 === strlen( $value ) ) {
+ return false;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'id' === $field || 'term_id' === $field ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $term = get_term( (int) $value, $taxonomy, $output, $filter );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $term ) || null === $term ) {
</span></span></pre></div>
<a id="trunktestsphpunitteststermgetTermByphp"></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/getTermBy.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/term/getTermBy.php 2017-03-16 01:34:52 UTC (rev 40292)
+++ trunk/tests/phpunit/tests/term/getTermBy.php 2017-03-16 02:03:53 UTC (rev 40293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -205,4 +205,48 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 0, $action->get_call_count() );
</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 21760
+ */
+ public function test_get_term_by_name_with_string_0() {
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+
+ $term_id = $this->factory->term->create( array(
+ 'name' => '0',
+ 'taxonomy' => 'wptests_tax',
+ ) );
+
+ $found = get_term_by( 'name', '0', 'wptests_tax' );
+ $this->assertSame( $term_id, $found->term_id );
+ }
+
+ /**
+ * @ticket 21760
+ */
+ public function test_get_term_by_slug_with_string_0() {
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+
+ $term_id = $this->factory->term->create( array(
+ 'taxonomy' => 'wptests_tax',
+ 'name' => '0',
+ 'slug' => '0',
+ ) );
+
+ $found = get_term_by( 'slug', '0', 'wptests_tax' );
+ $this->assertSame( $term_id, $found->term_id );
+ }
+
+ /**
+ * @ticket 21760
+ */
+ public function test_get_term_by_with_empty_string() {
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+
+ $found_by_slug = get_term_by( 'slug', '', 'wptests_tax' );
+ $found_by_name = get_term_by( 'name', '', 'wptests_tax' );
+
+ $this->assertFalse( $found_by_slug );
+ $this->assertFalse( $found_by_name );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</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 2017-03-16 01:34:52 UTC (rev 40292)
+++ trunk/tests/phpunit/tests/term/getTerms.php 2017-03-16 02:03:53 UTC (rev 40293)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2223,6 +2223,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return 'foo';
</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 21760
+ */
+ public function test_with_term_slug_equal_to_string_0() {
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+
+ $term_id = self::factory()->term->create( array(
+ 'name' => '0',
+ 'slug' => '0',
+ 'taxonomy' => 'wptests_tax',
+ ) );
+
+ $found = get_terms( array(
+ 'taxonomy' => 'wptests_tax',
+ 'hide_empty' => 0,
+ 'slug' => '0',
+ ) );
+
+ $this->assertEqualSets( array( $term_id ), wp_list_pluck( $found, 'term_id' ) );
+ }
+
+ /**
+ * @ticket 21760
+ */
+ public function test_with_multiple_term_slugs_one_equal_to_string_0() {
+ register_taxonomy( 'wptests_tax', 'post', array( 'hierarchical' => true ) );
+
+ $term_id1 = self::factory()->term->create( array(
+ 'name' => '0',
+ 'slug' => '0',
+ 'taxonomy' => 'wptests_tax',
+ ) );
+
+ $term_id2 = self::factory()->term->create( array(
+ 'name' => 'Test',
+ 'slug' => 'test',
+ 'taxonomy' => 'wptests_tax',
+ ) );
+
+ $found = get_terms( array(
+ 'taxonomy' => 'wptests_tax',
+ 'hide_empty' => 0,
+ 'slug' => array(
+ '0',
+ 'test',
+ ),
+ ) );
+
+ $this->assertEqualSets( array( $term_id1, $term_id2 ), wp_list_pluck( $found, 'term_id' ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> protected function create_hierarchical_terms_and_posts() {
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>