Changeset 34696

Timestamp:

09/29/2015 07:11:12 PM (9 years ago)

Author:

boonebgorges

Message:

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 #12981.

Location:

trunk

Files:

• src/wp-includes/category-template.php (modified) (2 diffs)
• tests/phpunit/tests/category/wpListCategories.php (modified) (1 diff)

trunk/src/wp-includes/category-template.php

@@ -499 +499 @@
  *     @type int          $child_of              Term ID to retrieve child terms of. See {@link get_terms()}. Default 0.
  *     @type array|string $exclude               Array or comma/space-separated string of term IDs to exclude.
- *                                               See {@link get_terms()}. Default empty string.
+ *                                               If `$hierarchical` is true, descendants of `$exclude` terms will also
+ *                                               be excluded; see `$exclude_tree`. See {@link get_terms()}.
+ *                                               Default empty string.
  *     @type array|string $exclude_tree          Array or comma/space-separated string of term IDs to exclude, along
  *                                               with their descendants. See {@link get_terms()}. Default empty string.
@@ -537 +539 @@
         $r['pad_counts'] = true;
 
+    // Descendants of exclusions should be excluded too.
     if ( true == $r['hierarchical'] ) {
-        $r['exclude_tree'] = $r['exclude'];
+        $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;
         $r['exclude'] = '';
     }

trunk/tests/phpunit/tests/category/wpListCategories.php

@@ -265 +265 @@
         $this->assertContains( '<li class="categories">Categories', $found );
     }
+
+    /**
+     * @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 );
+    }
 }