Changeset 34376

Timestamp:

09/22/2015 04:24:53 AM (9 years ago)

Author:

wonderboymusic

Message:

Widgets: Make the categories widget work with custom taxonomies.

Props fonglh, wonderboymusic, DrewAPicture, kucrut.
Fixes #21165.

Location:

trunk/src/wp-includes

Files:

• taxonomy-functions.php (modified) (2 diffs)
• widgets/class-wp-widget-categories.php (modified) (6 diffs)

trunk/src/wp-includes/taxonomy-functions.php

@@ -460 +460 @@
  * - name - general name for the taxonomy, usually plural. The same as and overridden by $tax->label. Default is Tags/Categories
  * - singular_name - name for one object of this taxonomy. Default is Tag/Category
+ * - select_name - prompt to select a taxonomy when using a dropdown list in the Categories widget. Default is 'Select Category'.
  * - search_items - Default is Search Tags/Search Categories
  * - popular_items - This string isn't used on hierarchical taxonomies. Default is Popular Tags
@@ -498 +499 @@
         'name' => array( _x( 'Tags', 'taxonomy general name' ), _x( 'Categories', 'taxonomy general name' ) ),
         'singular_name' => array( _x( 'Tag', 'taxonomy singular name' ), _x( 'Category', 'taxonomy singular name' ) ),
+        'select_name' => array( null, __( 'Select Category' ) ),
         'search_items' => array( __( 'Search Tags' ), __( 'Search Categories' ) ),
         'popular_items' => array( __( 'Popular Tags' ), null ),

trunk/src/wp-includes/widgets/class-wp-widget-categories.php

@@ -23 +23 @@
         static $first_dropdown = true;
 
+        $current_taxonomy = $this->_get_current_taxonomy( $instance );
+
         /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
         $title = apply_filters( 'widget_title', empty( $instance['title'] ) ? __( 'Categories' ) : $instance['title'], $instance, $this->id_base );
@@ -35 +37 @@
         }
 
+        $tax = get_taxonomy( $current_taxonomy );
+
         $cat_args = array(
             'orderby'      => 'name',
             'show_count'   => $c,
-            'hierarchical' => $h
+            'hierarchical' => $h,
+            'taxonomy'     => $current_taxonomy,
         );
 
@@ -47 +52 @@
             echo '<label class="screen-reader-text" for="' . esc_attr( $dropdown_id ) . '">' . $title . '</label>';
 
-            $cat_args['show_option_none'] = __( 'Select Category' );
+            $cat_args['show_option_none'] = $tax->labels->select_name;
             $cat_args['id'] = $dropdown_id;
 
@@ -110 +115 @@
         $instance['hierarchical'] = !empty($new_instance['hierarchical']) ? 1 : 0;
         $instance['dropdown'] = !empty($new_instance['dropdown']) ? 1 : 0;
+        $instance['taxonomy'] = stripslashes( $new_instance['taxonomy'] );
 
         return $instance;
@@ -124 +130 @@
         $hierarchical = isset( $instance['hierarchical'] ) ? (bool) $instance['hierarchical'] : false;
         $dropdown = isset( $instance['dropdown'] ) ? (bool) $instance['dropdown'] : false;
+        $current_taxonomy = $this->_get_current_taxonomy( $instance );
 ?>
         <p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e( 'Title:' ); ?></label>
         <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr( $title ); ?>" /></p>
+
+        <p>
+            <label for="<?php echo esc_attr( $this->get_field_id( 'taxonomy' ) ); ?>"><?php _e( 'Taxonomy:' ) ?></label>
+            <select class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'taxonomy' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'taxonomy' ) ); ?>">
+            <?php foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) : ?>
+                <?php
+                if ( ! $taxonomy->hierarchical || empty( $taxonomy->labels->name ) ) :
+                    continue;
+                endif;
+                ?>
+                <option value="<?php echo esc_attr( $taxonomy->name ); ?>" <?php selected( $taxonomy->name, $current_taxonomy ) ?>><?php echo esc_html( $taxonomy->labels->name ); ?></option>
+            <?php endforeach; ?>
+            </select>
+        </p>
 
         <p><input type="checkbox" class="checkbox" id="<?php echo $this->get_field_id('dropdown'); ?>" name="<?php echo $this->get_field_name('dropdown'); ?>"<?php checked( $dropdown ); ?> />
@@ -139 +160 @@
     }
 
+    /**
+     * Retrieves the taxonomy for the current widget instance.
+     *
+     * @since 4.4.0
+     * @access public
+     *
+     * @param array $instance Current settings.
+     * @return string Name of the current taxonomy if set, otherwise 'category'.
+     */
+    public function _get_current_taxonomy( $instance ) {
+        if ( ! empty( $instance['taxonomy'] ) && taxonomy_exists( $instance['taxonomy'] ) ) {
+            return $instance['taxonomy'];
+        }
+        return 'category';
+    }
 }