<!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>[31275] trunk: Introduce 'childless' parameter to `get_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 { 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/31275">31275</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/31275","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>2015-01-24 18:47:30 +0000 (Sat, 24 Jan 2015)</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'>Introduce 'childless' parameter to `get_terms()`.
This new parameter allows developers to limit queried terms to terminal nodes -
ie, those without any descendants.
As part of the improvement, some internal logic in `get_terms()` has been
consolidated. Parameters that resolve to a NOT IN clause containing term IDs
('exclude', 'exclude_tree', and 'childless') are now parsed into a single
"exclusions" array before the SQL clause is generated.
Props theMikeD, horike.
Fixes <a href="https://core.trac.wordpress.org/ticket/29839">#29839</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludestaxonomyphp">trunk/src/wp-includes/taxonomy.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="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 2015-01-24 15:06:43 UTC (rev 31274)
+++ trunk/src/wp-includes/taxonomy.php 2015-01-24 18:47:30 UTC (rev 31275)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1547,7 +1547,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * along with the $args array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.2.0 Introduced 'name' parameter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0 Introduced 'name' and 'childless' parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1595,6 +1595,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies
</span><span class="cx" style="display: block; padding: 0 10px"> * are passed, $child_of is ignored. Default 0.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int|string $parent Parent term ID to retrieve direct-child terms of. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type bool $childless True to limit results to terms that have no children. This parameter has
+ * no effect on non-hierarchical taxonomies. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $cache_domain Unique cache key to be produced when this query is stored in an
</span><span class="cx" style="display: block; padding: 0 10px"> * object cache. Default is 'core'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1619,7 +1621,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $defaults = array('orderby' => 'name', 'order' => 'ASC',
</span><span class="cx" style="display: block; padding: 0 10px"> 'hide_empty' => true, 'exclude' => array(), 'exclude_tree' => array(), 'include' => array(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'number' => '', 'fields' => 'all', 'name' => '', 'slug' => '', 'parent' => '',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'number' => '', 'fields' => 'all', 'name' => '', 'slug' => '', 'parent' => '', 'childless' => false,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '', 'description__like' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'pad_counts' => false, 'offset' => '', 'search' => '', 'cache_domain' => 'core' );
</span><span class="cx" style="display: block; padding: 0 10px"> $args = wp_parse_args( $args, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1638,6 +1640,7 @@
</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"> if ( 'all' == $args['get'] ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['childless'] = false;
</ins><span class="cx" style="display: block; padding: 0 10px"> $args['child_of'] = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $args['hide_empty'] = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $args['hierarchical'] = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1754,6 +1757,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $where .= $inclusions;
</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">+ $exclusions = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $exclude_tree ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $exclude_tree = wp_parse_id_list( $exclude_tree );
</span><span class="cx" style="display: block; padding: 0 10px"> $excluded_children = $exclude_tree;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1763,22 +1767,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> (array) get_terms( $taxonomies[0], array( 'child_of' => intval( $extrunk ), 'fields' => 'ids', 'hide_empty' => 0 ) )
</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">- $exclusions = implode( ',', array_map( 'intval', $excluded_children ) );
- } else {
- $exclusions = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $exclusions = array_merge( $excluded_children, $exclusions );
</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"> if ( ! empty( $exclude ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $exterms = wp_parse_id_list( $exclude );
- if ( empty( $exclusions ) ) {
- $exclusions = implode( ',', $exterms );
- } else {
- $exclusions .= ', ' . implode( ',', $exterms );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $exclusions = array_merge( wp_parse_id_list( $exclude ), $exclusions );
+ }
+
+ // 'childless' terms are those without an entry in the flattened term hierarchy.
+ $childless = (bool) $args['childless'];
+ if ( $childless ) {
+ foreach ( $taxonomies as $_tax ) {
+ $term_hierarchy = _get_term_hierarchy( $_tax );
+ $exclusions = array_merge( array_keys( $term_hierarchy ), $exclusions );
</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">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $exclusions ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $exclusions = ' AND t.term_id NOT IN (' . $exclusions . ')';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $exclusions = ' AND t.term_id NOT IN (' . implode( ',', array_map( 'intval', $exclusions ) ) . ')';
</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"> /**
</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 2015-01-24 15:06:43 UTC (rev 31274)
+++ trunk/tests/phpunit/tests/term/getTerms.php 2015-01-24 18:47:30 UTC (rev 31275)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -495,6 +495,121 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array( $t3, $t1 ), $found );
</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 29839
+ */
+ public function test_childless_should_return_all_terms_for_flat_hierarchy() {
+ // If run on a flat hierarchy it should return everything.
+ $flat_tax = 'countries';
+ register_taxonomy( $flat_tax, 'post', array( 'hierarchical' => false ) );
+ $australia = $this->factory->term->create( array( 'name' => 'Australia', 'taxonomy' => $flat_tax ) );
+ $china = $this->factory->term->create( array( 'name' => 'China', 'taxonomy' => $flat_tax ) );
+ $tanzania = $this->factory->term->create( array( 'name' => 'Tanzania', 'taxonomy' => $flat_tax ) );
+
+ $terms = get_terms( $flat_tax, array(
+ 'childless' => true,
+ 'hide_empty' => false,
+ 'fields' => 'ids',
+ ) );
+
+ $expected = array( $australia, $china, $tanzania );
+ $this->assertEqualSets( $expected, $terms );
+ }
+
+
+ /**
+ * @ticket 29839
+ */
+ public function test_childless_hierarchical_taxonomy() {
+ $tax = 'location';
+ register_taxonomy( $tax, 'post', array( 'hierarchical' => true ) );
+ /*
+ Canada
+ Ontario
+ Ottawa
+ Nepean
+ Toronto
+ Quebec
+ Montreal
+ PEI
+ */
+ // Level 1
+ $canada = $this->factory->term->create( array( 'name' => 'Canada', 'taxonomy' => $tax ) );
+
+ // Level 2
+ $ontario = $this->factory->term->create( array( 'name' => 'Ontario', 'parent' => $canada, 'taxonomy' => $tax ) );
+ $quebec = $this->factory->term->create( array( 'name' => 'Quebec', 'parent' => $canada, 'taxonomy' => $tax ) );
+ $pei = $this->factory->term->create( array( 'name' => 'PEI', 'parent' => $canada, 'taxonomy' => $tax ) );
+
+ // Level 3
+ $toronto = $this->factory->term->create( array( 'name' => 'Toronto', 'parent' => $ontario, 'taxonomy' => $tax ) );
+ $ottawa = $this->factory->term->create( array( 'name' => 'Ottawa', 'parent' => $ontario, 'taxonomy' => $tax ) );
+ $montreal = $this->factory->term->create( array( 'name' => 'Montreal', 'parent' => $quebec, 'taxonomy' => $tax ) );
+
+ // Level 4
+ $nepean = $this->factory->term->create( array( 'name' => 'Nepean', 'parent' => $ottawa, 'taxonomy' => $tax ) );
+
+ $terms = get_terms( $tax, array(
+ 'childless' => true,
+ 'hide_empty' => false,
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEqualSets( array( $montreal, $nepean, $toronto, $pei ), $terms );
+ }
+
+ /**
+ * @ticket 29839
+ */
+ public function test_childless_hierarchical_taxonomy_used_with_child_of() {
+ $tax = 'location';
+ register_taxonomy( $tax, 'post', array( 'hierarchical' => true ) );
+
+ // Level 1
+ $canada = $this->factory->term->create( array( 'name' => 'Canada', 'taxonomy' => $tax ) );
+
+ // Level 2
+ $ontario = $this->factory->term->create( array( 'name' => 'Ontario', 'parent' => $canada, 'taxonomy' => $tax ) );
+ $quebec = $this->factory->term->create( array( 'name' => 'Quebec', 'parent' => $canada, 'taxonomy' => $tax ) );
+
+ // Level 3
+ $laval = $this->factory->term->create( array( 'name' => 'Laval', 'parent' => $quebec, 'taxonomy' => $tax ) );
+ $montreal = $this->factory->term->create( array( 'name' => 'Montreal', 'parent' => $quebec, 'taxonomy' => $tax ) );
+
+ // Level 4
+ $dorval = $this->factory->term->create( array( 'name' => 'Dorval', 'parent' => $montreal, 'taxonomy' => $tax ) );
+
+ $terms = get_terms( $tax, array(
+ 'childless' => true,
+ 'child_of' => $quebec,
+ 'hide_empty' => false,
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEqualSets( array( $laval ), $terms );
+ }
+
+ /**
+ * @ticket 29839
+ */
+ public function test_childless_should_enforce_childless_status_for_all_queried_taxonomies() {
+ register_taxonomy( 'wptests_tax1', 'post', array( 'hierarchical' => true ) );
+ register_taxonomy( 'wptests_tax2', 'post', array( 'hierarchical' => true ) );
+
+ $t1 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax1' ) );
+ $t2 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax1', 'parent' => $t1 ) );
+ $t3 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax2' ) );
+ $t4 = $this->factory->term->create( array( 'taxonomy' => 'wptests_tax2', 'parent' => $t3 ) );
+
+ $found = get_terms( array( 'wptests_tax1', 'wptests_tax2' ), array(
+ 'fields' => 'ids',
+ 'hide_empty' => false,
+ 'childless' => true,
+ ) );
+
+ $this->assertEqualSets( array( $t2, $t4 ), $found );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_terms_hierarchical_tax_hide_empty_false_fields_ids() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Set up a clean taxonomy.
</span><span class="cx" style="display: block; padding: 0 10px"> $tax = 'hierarchical_fields';
</span></span></pre>
</div>
</div>
</body>
</html>