<!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>[34696] trunk: Fix 'exclude_tree' in `wp_list_categories()`.</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/34696">34696</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/34696","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-09-29 19:11:12 +0000 (Tue, 29 Sep 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'>Fix 'exclude_tree' in `wp_list_categories()`.
The 'exclude_tree' parameter must be compatible with 'hierarchical';
previously, 'hierarchical' canceled it out. This changeset also makes it so
that 'exclude_tree' is compatible with 'exclude'. When both are passed, and
'hierarchical' is true, the descendant trees of terms in both parameters will
be excluded from matched terms.
Props tott, webord, MikeHansenMe.
Fixes <a href="https://core.trac.wordpress.org/ticket/12981">#12981</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
<li><a href="#trunktestsphpunittestscategorywpListCategoriesphp">trunk/tests/phpunit/tests/category/wpListCategories.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescategorytemplatephp"></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/category-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php 2015-09-29 18:51:20 UTC (rev 34695)
+++ trunk/src/wp-includes/category-template.php 2015-09-29 19:11:12 UTC (rev 34696)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -498,7 +498,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $feed_image URL of an image to use for the feed link. Default empty string.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $child_of Term ID to retrieve child terms of. See {@link get_terms()}. Default 0.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * See {@link get_terms()}. Default empty string.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If `$hierarchical` is true, descendants of `$exclude` terms will also
+ * be excluded; see `$exclude_tree`. See {@link get_terms()}.
+ * Default empty string.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
</span><span class="cx" style="display: block; padding: 0 10px"> * with their descendants. See {@link get_terms()}. Default empty string.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool|int $echo True to echo markup, false to return it. Default 1.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -536,8 +538,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] )
</span><span class="cx" style="display: block; padding: 0 10px"> $r['pad_counts'] = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Descendants of exclusions should be excluded too.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( true == $r['hierarchical'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $r['exclude_tree'] = $r['exclude'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $exclude_tree = array();
+
+ if ( $r['exclude_tree'] ) {
+ $exclude_tree = array_merge( $exclude_tree, (array) $r['exclude_tree'] );
+ }
+
+ if ( $r['exclude'] ) {
+ $exclude_tree = array_merge( $exclude_tree, (array) $r['exclude'] );
+ }
+
+ $r['exclude_tree'] = $exclude_tree;
</ins><span class="cx" style="display: block; padding: 0 10px"> $r['exclude'] = '';
</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="trunktestsphpunittestscategorywpListCategoriesphp"></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/category/wpListCategories.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/category/wpListCategories.php 2015-09-29 18:51:20 UTC (rev 34695)
+++ trunk/tests/phpunit/tests/category/wpListCategories.php 2015-09-29 19:11:12 UTC (rev 34696)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,4 +264,47 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( '<li class="categories">Categories', $found );
</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 12981
+ */
+ public function test_exclude_tree_should_be_respected() {
+ $c = $this->factory->category->create();
+ $parent = $this->factory->category->create( array( 'name' => 'Parent', 'slug' => 'parent' ) );
+ $child = $this->factory->category->create( array( 'name' => 'Child', 'slug' => 'child', 'parent' => $parent ) );
+
+ $args = array( 'echo' => 0, 'hide_empty' => 0, 'exclude_tree' => $parent );
+
+ $actual = wp_list_categories( $args );
+
+ $this->assertNotContains( '<li class="cat-item cat-item-' . $parent . '">', $actual );
+
+ $this->assertNotContains( '<li class="cat-item cat-item-' . $child . '">', $actual );
+ }
+
+ /**
+ * @ticket 12981
+ */
+ public function test_exclude_tree_should_be_merged_with_exclude() {
+ $c = $this->factory->category->create();
+ $parent = $this->factory->category->create( array( 'name' => 'Parent', 'slug' => 'parent' ) );
+ $child = $this->factory->category->create( array( 'name' => 'Child', 'slug' => 'child', 'parent' => $parent ) );
+ $parent2 = $this->factory->category->create( array( 'name' => 'Parent', 'slug' => 'parent2' ) );
+ $child2 = $this->factory->category->create( array( 'name' => 'Child', 'slug' => 'child2', 'parent' => $parent2 ) );
+
+ $args = array( 'echo' => 0, 'hide_empty' => 0, 'exclude_tree' => $parent );
+
+ $actual = wp_list_categories( array(
+ 'echo' => 0,
+ 'hide_empty' => 0,
+ 'exclude' => $parent,
+ 'exclude_tree' => $parent2,
+ ) );
+
+ $this->assertNotContains( '<li class="cat-item cat-item-' . $parent . '">', $actual );
+ $this->assertNotContains( '<li class="cat-item cat-item-' . $parent2 . '">', $actual );
+ $this->assertNotContains( '<li class="cat-item cat-item-' . $child . '">', $actual );
+
+ $this->assertNotContains( '<li class="cat-item cat-item-' . $child2 . '">', $actual );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>