Changeset 33804

Timestamp:

08/29/2015 07:45:35 PM (9 years ago)

Author:

boonebgorges

Message:

In wp_list_categories(), 'current_category' should accept an array of values.

This allows the 'current-cat' or 'current-cat-parent' classes to be applied
to more than one item in the list.

Props vilkatis.
Fixes #33565.

Location:

trunk

Files:

• src/wp-includes/category-template.php (modified) (3 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_empty` argument.
+ * @since 4.4.0 Introduced the `hide_title_if_empty` argument. The `current_category` argument was modified to
+ *              optionally accept an array of values.
  *
  * @param string|array $args {
@@ -489 +490 @@
  *                                               with their descendants. See {@link get_terms()}. Default empty string.
  *     @type bool|int     $echo                  True to echo markup, false to return it. Default 1.
- *     @type int          $current_category      Category that should get the 'current-cat' class. Default 0.
+ *     @type int|array    $current_category      ID of category, or array of IDs of categories, that should get the
+ *                                               'current-cat' class. Default 0.
  *     @type bool         $hierarchical          Whether to include terms that have non-empty descendants.
  *                                               See {@link get_terms()}. Default true.
@@ -1122 +1124 @@
 
             if ( ! empty( $args['current_category'] ) ) {
-                $_current_category = get_term( $args['current_category'], $category->taxonomy );
-                if ( $category->term_id == $args['current_category'] ) {
-                    $css_classes[] = 'current-cat';
-                } elseif ( $category->term_id == $_current_category->parent ) {
-                    $css_classes[] = 'current-cat-parent';
+                // 'current_category' can be an array, so we use `get_terms()`.
+                $_current_terms = get_terms( $category->taxonomy, array(
+                    'include' => $args['current_category'],
+                    'hide_empty' => false,
+                ) );
+
+                foreach ( $_current_terms as $_current_term ) {
+                    if ( $category->term_id == $_current_term->term_id ) {
+                        $css_classes[] = 'current-cat';
+                    } elseif ( $category->term_id == $_current_term->parent ) {
+                        $css_classes[] = 'current-cat-parent';
+                    }
                 }
             }

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

@@ -47 +47 @@
 
     /**
+     * @ticket 33565
+     */
+    public function test_current_category_should_accept_an_array_of_ids() {
+        $cats = $this->factory->category->create_many( 3 );
+
+        $found = wp_list_categories( array(
+            'echo' => false,
+            'hide_empty' => false,
+            'current_category' => array( $cats[0], $cats[2] ),
+        ) );
+
+        $this->assertRegExp( '/class="[^"]*cat-item-' . $cats[0] . '[^"]*current-cat[^"]*"/', $found );
+        $this->assertNotRegExp( '/class="[^"]*cat-item-' . $cats[1] . '[^"]*current[^"]*"/', $found );
+        $this->assertRegExp( '/class="[^"]*cat-item-' . $cats[2] . '[^"]*current-cat[^"]*"/', $found );
+    }
+
+    /**
      * @ticket 16792
      */