Changeset 33764

Timestamp:

08/26/2015 07:41:55 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce hide_title_if_no_cats parameter to wp_list_categories().

When generating a <ul> using wp_list_categories(), a title <li> element
is put at the top of the term list. Current behavior is that this title <li>
appears even when no terms are found. The new hide_title_if_no_cats param
allows developers to specify that the title should be hidden when the term list
is empty.

Props vilkatis.
Fixes #33460.

Location:

trunk

Files:

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

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

@@ -462 +462 @@
  *
  * @since 2.1.0
+ * @since 4.4.0 Introduced the `hide_title_if_no_cats` argument.
  *
  * @param string|array $args {
@@ -492 +493 @@
  *     @type string       $title_li           Text to use for the list title `<li>` element. Pass an empty string
  *                                            to disable. Default 'Categories'.
+ *     @type bool         $hide_title_if_no_cats Whether to hide the `$title_li` element if there are no terms in
+ *                                               the list. Default false (title will always be shown).
  *     @type int          $depth              Category depth. Used for tab indentation. Default 0.
  *     @type string       $taxonomy           Taxonomy name. Default 'category'.
@@ -508 +511 @@
         'exclude_tree' => '', 'current_category' => 0,
         'hierarchical' => true, 'title_li' => __( 'Categories' ),
+        'hide_title_if_no_cats' => false,
         'echo' => 1, 'depth' => 0,
         'taxonomy' => 'category'
@@ -535 +539 @@
 
     $output = '';
-    if ( $r['title_li'] && 'list' == $r['style'] ) {
+    if ( $r['title_li'] && 'list' == $r['style'] && ( ! empty( $categories ) || ! $r['hide_title_if_no_cats'] ) ) {
         $output = '<li class="' . esc_attr( $r['class'] ) . '">' . $r['title_li'] . '<ul>';
     }

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

@@ -198 +198 @@
         return $cat;
     }
+
+    /**
+     * @ticket 33460
+     */
+    public function test_title_li_should_be_shown_by_default_for_empty_lists() {
+        $found = wp_list_categories( array(
+            'echo' => false,
+        ) );
+
+        $this->assertContains( '<li class="categories">Categories', $found );
+    }
+
+    /**
+     * @ticket 33460
+     */
+    public function test_hide_title_if_no_cats_should_be_respected_for_empty_lists_when_true() {
+        $found = wp_list_categories( array(
+            'echo' => false,
+            'hide_title_if_no_cats' => true,
+        ) );
+
+        $this->assertNotContains( '<li class="categories">Categories', $found );
+    }
+
+    /**
+     * @ticket 33460
+     */
+    public function test_hide_title_if_no_cats_should_be_respected_for_empty_lists_when_false() {
+        $found = wp_list_categories( array(
+            'echo' => false,
+            'hide_title_if_no_cats' => false,
+        ) );
+
+        $this->assertContains( '<li class="categories">Categories', $found );
+    }
+
+    /**
+     * @ticket 33460
+     */
+    public function test_hide_title_if_no_cats_should_be_ignored_when_category_list_is_not_empty() {
+        $cat = $this->factory->category->create();
+
+        $found = wp_list_categories( array(
+            'echo' => false,
+            'hide_empty' => false,
+            'hide_title_if_no_cats' => true,
+        ) );
+
+        $this->assertContains( '<li class="categories">Categories', $found );
+    }
 }