Newer
Older
<?php
/*
Plugin Name: Taxonomy Dropdown Widget
Plugin URI: https://ethitter.com/plugins/taxonomy-dropdown-widget/
Description: Creates a dropdown list of non-hierarchical taxonomies as an alternative to the term (tag) cloud. Widget provides numerous options to tailor the output to fit your site. Dropdown function can also be called directly for use outside of the widget. Formerly known as <strong><em>Tag Dropdown Widget</em></strong>.
Author: Erick Hitter
Author URI: https://ethitter.com/
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
** TAXONOMY DROPDOWN WIDGET PLUGIN
**/
class taxonomy_dropdown_widget_plugin {
/**
* Singleton!
*/
private static $__instance = null;
'taxonomy' => 'post_tag',
'select_name' => 'Select Tag',
'cutoff' => '…',
'limit' => 0,
'order' => 'ASC',
'orderby' => 'name',
'threshold' => 0,
'incexc' => 'exclude',
'incexc_ids' => array(),
'hide_empty' => true,
'post_counts' => false,
/**
* Implement the singleton
*
* @return object
*/
public static function get_instance() {
if ( ! is_a( self::$__instance, __CLASS__ ) ) {
self::$__instance = new self;
self::$__instance->setup();
/**
* Silence is golden!
*/
private function __construct() {}
* Register actions and activation/deactivation hooks
* @uses add_action
* @uses register_activation_hook
* @uses register_deactivation_hook
protected function setup() {
add_action( 'widgets_init', array( $this, 'action_widgets_init' ) );
register_activation_hook( __FILE__, array( $this, 'activation_hook' ) );
register_deactivation_hook( __FILE__, array( $this, 'deactivation_hook' ) );
}
/**
* Allow access to certain variables that were previously public
*
* @return mixed
*/
public function __get( $var ) {
Erick Hitter
committed
if ( 'option_defaults' == $var ) {
return $this->option_defaults;
Erick Hitter
committed
}
Erick Hitter
committed
return null;
}
* Run plugin cleanup on activation
* @hook activation
* @return null
*/
* Unregister widget when plugin is deactivated and run cleanup
* @hook deactivation
* @return null
*/
public function deactivation_hook() {
* Remove options related to plugin versions older than 2.0.
* @uses delete_option
* @return null
*/
if ( ! apply_filters( 'taxonomy_dropdown_widget_run_cleanup', true ) ) {
Erick Hitter
committed
}
// Remove unused options
$legacy_options = array(
'widget_TagDropdown',
'widget_TagDropdown_exclude',
'function_TagDropdown',
foreach ( $legacy_options as $legacy_option ) {
delete_option( $legacy_option );
// Let others play too
do_action( 'taxonomy_dropdown_widget_cleanup' );
* Register widget
* @uses register_widget
* @action widgets_init
* @return null
*/
register_widget( 'taxonomy_dropdown_widget' );
Erick Hitter
committed
*
* @param array $options
* @param string|int $id
Erick Hitter
committed
* @uses this::sanitize_options
* @uses sanitize_title
* @uses apply_filters
* @uses get_terms
Erick Hitter
committed
* @uses esc_attr
* @uses esc_html
* @uses is_tag
* @uses is_tax
* @uses esc_url
* @uses get_term_link
* @uses selected
* @return string or false
*/
public function render_dropdown( $options, $id = false ) {
$options = wp_parse_args( $options, $this->option_defaults );
Erick Hitter
committed
$options = $this->sanitize_options( $options );
$id = is_numeric( $id ) ? intval( $id ) : sanitize_title( $id );
// Set up options array for get_terms
$terms_options = array(
'order' => $options['order'],
'orderby' => $options['orderby'],
'hide_empty' => $options['hide_empty'],
Erick Hitter
committed
if ( $options['limit'] ) {
Erick Hitter
committed
$terms_options[ 'number' ] = $options['limit'];
Erick Hitter
committed
}
Erick Hitter
committed
if ( ! empty( $options['incexc_ids'] ) ) {
$terms_options[ $options['incexc'] ] = $options['incexc_ids'];
Erick Hitter
committed
}
Erick Hitter
committed
$terms_options = apply_filters( 'taxonomy_dropdown_widget_options', $terms_options, $id );
$terms_options = apply_filters( 'TagDropdown_get_tags', $terms_options );
Erick Hitter
committed
// Get terms
$terms = get_terms( $options['taxonomy'], $terms_options );
Erick Hitter
committed
if ( is_array( $terms ) && ! empty( $terms ) ) {
// Determine CSS ID
Erick Hitter
committed
if ( is_int( $id ) ) {
$css_id = ' id="taxonomy_dropdown_widget_dropdown_' . $id . '"';
Erick Hitter
committed
} elseif ( ! empty( $id ) ) {
Erick Hitter
committed
$css_id = ' id="' . esc_attr( $id ) . '"';
Erick Hitter
committed
} else {
Erick Hitter
committed
$css_id = '';
Erick Hitter
committed
}
Erick Hitter
committed
// Start dropdown
$output = '<select name="taxonomy_dropdown_widget_dropdown_' . esc_attr( $id ) . '" class="taxonomy_dropdown_widget_dropdown" onchange="document.location.href=this.options[this.selectedIndex].value;"' . $css_id . '>' . "\r\n";
Erick Hitter
committed
$output .= "\t" . '<option value="">' . esc_html( $options['select_name'] ) . '</option>' . "\r\n";
Erick Hitter
committed
// Populate dropdown
Erick Hitter
committed
if ( $options['threshold'] > 0 && $term->count < $options['threshold'] ) {
Erick Hitter
committed
}
Erick Hitter
committed
// Set selected attribute if on an archive page for the current term
$current = is_tag() ? is_tag( $term->slug ) : is_tax( $term->taxonomy, $term->slug );
Erick Hitter
committed
// Open option tag
$output .= "\t" . '<option value="' . esc_url( get_term_link( (int) $term->term_id, $term->taxonomy ) ) . '"' . ( selected( $current, true , false ) ) . '>';
Erick Hitter
committed
// Tag name
$name = esc_attr( $term->name );
Erick Hitter
committed
if ( $options['max_name_length'] > 0 && strlen( $name ) > $options['max_name_length'] ) {
Erick Hitter
committed
$name = substr( $name, 0, $options['max_name_length'] ) . $options['cutoff'];
Erick Hitter
committed
}
Erick Hitter
committed
// Count
Erick Hitter
committed
if ( $options['post_counts'] ) {
$output .= ' (' . intval( $term->count ) . ')';
Erick Hitter
committed
}
Erick Hitter
committed
// Close option tag
$output .= '</option>' . "\r\n";
Erick Hitter
committed
// End dropdown
$output .= '</select>' . "\r\n";
* Sanitize plugin options
* @param array $options
* @uses taxonomy_exists
* @uses sanitize_text_field
* @uses absint
* @uses wp_parse_args
'hide_empty' => true,
'post_counts' => false,
);
$keys = array_merge( array_keys( $this->option_defaults ), array( 'title' ) );
if ( is_array( $options ) ) {
foreach ( $keys as $key ) {
Erick Hitter
committed
if ( ! array_key_exists( $key, $options ) ) {
Erick Hitter
committed
}
$value = $options[ $key ];
switch( $key ) {
Erick Hitter
committed
if ( taxonomy_exists( $value ) ) {
$options_sanitized[ $key ] = $value;
Erick Hitter
committed
}
case 'title' :
case 'select_name' :
case 'cutoff' :
$value = sanitize_text_field( $value );
Erick Hitter
committed
if ( ! empty( $value ) || $key == 'title' ) {
$options_sanitized[ $key ] = $value;
Erick Hitter
committed
}
case 'max_name_length' :
case 'limit' :
case 'threshold' :
$options_sanitized[ $key ] = absint( $value );
break;
Erick Hitter
committed
if ( $value == 'ASC' || $value == 'DESC' ) {
$options_sanitized[ $key ] = $value;
Erick Hitter
committed
}
Erick Hitter
committed
if ( $value == 'name' || $value == 'count' ) {
$options_sanitized[ $key ] = $value;
Erick Hitter
committed
}
Erick Hitter
committed
if ( $value == 'include' || $value == 'exclude' ) {
$options_sanitized[ $key ] = $value;
Erick Hitter
committed
}
$options_sanitized[ $key ] = array();
Erick Hitter
committed
if ( is_string( $value ) ) {
$value = explode( ',', $value );
Erick Hitter
committed
}
if ( is_array( $value ) ) {
foreach ( $value as $term_id ) {
$term_id = intval( $term_id );
Erick Hitter
committed
if ( $term_id > 0 ) {
$options_sanitized[ $key ][] = $term_id;
Erick Hitter
committed
}
unset( $term_id );
}
sort( $options_sanitized[ $key ], SORT_NUMERIC );
}
break;
case 'hide_empty' :
case 'post_counts' :
$options_sanitized[ $key ] = (bool)$value;
break;
continue;
break;
}
}
}
// Ensure array contains all keys by parsing against defaults after options are sanitized
$options_sanitized = wp_parse_args( $options_sanitized, $this->option_defaults );
return $options_sanitized;
}
}
$GLOBALS['taxonomy_dropdown_widget_plugin'] = taxonomy_dropdown_widget_plugin::get_instance();
/**
** TAXONOMY DROPDOWN WIDGET
**/
class taxonomy_dropdown_widget extends WP_Widget {
Erick Hitter
committed
private $plugin = null;
* Register widget and populate class variables
Erick Hitter
committed
* @uses taxonomy_dropdown_widget_plugin::get_instance
$this->WP_Widget( false, 'Taxonomy Dropdown Widget', array( 'description' => 'Displays selected non-hierarchical taxonomy terms in a dropdown list.' ) );
Erick Hitter
committed
// Shortcut to the main plugin instance from within the widget class
$this->plugin = taxonomy_dropdown_widget_plugin::get_instance();
Erick Hitter
committed
if ( is_object( $this->plugin ) && is_array( $this->plugin->option_defaults ) ) {
Erick Hitter
committed
$this->defaults = array_merge( $this->plugin->option_defaults, $this->defaults );
Erick Hitter
committed
}
* Render widget
* @param array $args
* @param array $instance
* @return string or null
*/
Erick Hitter
committed
// Options
$instance = wp_parse_args( $instance, $this->defaults );
Erick Hitter
committed
// Widget
if ( $widget = $this->plugin->render_dropdown( $instance, $this->number ) ) {
// Wrapper and title
$output = $args['before_widget'] . "\r\n";
if ( ! empty( $instance['title'] ) ) {
$output .= $args['before_title'] . apply_filters( 'taxonomy_dropdown_widget_title', '<label for="taxonomy_dropdown_widget_dropdown_' . $this->number . '">' . $instance['title'] . '</label>', $this->number ) . $args['after_title'] . "\r\n";
Erick Hitter
committed
}
Erick Hitter
committed
// Widget
Erick Hitter
committed
// Wrapper
$output .= $args['after_widget'] . "\r\n";
echo $output;
}
}
* Options sanitization
* @param array $new_instance
* @param array $old_instance
* @return array
*/
public function update( $new_instance, $old_instance ) {
Erick Hitter
committed
return $this->plugin->sanitize_options( $new_instance );
* Widget options
* @param array $instance
* @uses wp_parse_args
* @uses get_taxonomies
* @uses _e
* @uses this::get_field_id
* @uses this::get_field_name
* @uses esc_attr
* @uses selected
* @uses checked
$options = wp_parse_args( $instance, $this->defaults );
// Get taxonomies and remove certain Core taxonomies that shouldn't be accessed directly.
$taxonomies = get_taxonomies( array(
Erick Hitter
committed
if ( array_key_exists( 'nav_menu', $taxonomies ) ) {
unset( $taxonomies[ 'nav_menu' ] );
Erick Hitter
committed
}
Erick Hitter
committed
if ( array_key_exists( 'post_format', $taxonomies ) ) {
unset( $taxonomies[ 'post_format' ] );
Erick Hitter
committed
}
?>
<h3><?php _e( 'Basic Settings' ); ?></h3>
<p>
<label for="<?php echo $this->get_field_id( 'taxonomy' ); ?>"><?php _e( 'Taxonomy' ); ?>:</label><br />
<select name="<?php echo $this->get_field_name( 'taxonomy' ); ?>" id="<?php echo $this->get_field_id( 'taxonomy' ); ?>">
<?php foreach ( $taxonomies as $tax ) : ?>
<option value="<?php echo esc_attr( $tax->name ); ?>"<?php selected( $tax->name, $options['taxonomy'], true ); ?>><?php echo $tax->labels->name; ?></option>
<?php endforeach; ?>
</select>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label><br />
<input type="text" name="<?php echo $this->get_field_name( 'title' ); ?>" class="widefat code" id="<?php echo $this->get_field_id( 'title' ); ?>" value="<?php echo esc_attr( $options['title'] ); ?>" />
</p>
<p>
<label for="<?php echo $this->get_field_id( 'select_name' ); ?>"><?php _e( 'Default dropdown item:' ); ?></label><br />
<input type="text" name="<?php echo $this->get_field_name( 'select_name' ); ?>" class="widefat code" id="<?php echo $this->get_field_id( 'select_name' ); ?>" value="<?php echo esc_attr( $options['select_name'] ); ?>" />
</p>
<h3><?php _e( 'Order' ); ?></h3>
<p>
<label><?php _e( 'Order terms by:' ); ?></label><br />
<input type="radio" name="<?php echo $this->get_field_name( 'orderby' ); ?>" value="name" id="<?php echo $this->get_field_name( 'order_name' ); ?>"<?php checked( $options['orderby'], 'name', true ); ?> />
<label for="<?php echo $this->get_field_name( 'order_name' ); ?>"><?php _e( 'Name' ); ?></label><br />
<input type="radio" name="<?php echo $this->get_field_name( 'orderby' ); ?>" value="count" id="<?php echo $this->get_field_name( 'order_count' ); ?>"<?php checked( $options['orderby'], 'count', true ); ?> />
<label for="<?php echo $this->get_field_name( 'order_count' ); ?>"><?php _e( 'Post count' ); ?></label>
</p>
<p>
<label><?php _e( 'Order terms:' ); ?></label><br />
<input type="radio" name="<?php echo $this->get_field_name( 'order' ); ?>" value="ASC" id="<?php echo $this->get_field_name( 'order_asc' ); ?>"<?php checked( $options['order'], 'ASC', true ); ?> />
<label for="<?php echo $this->get_field_name( 'order_asc' ); ?>"><?php _e( 'Ascending' ); ?></label><br />
<input type="radio" name="<?php echo $this->get_field_name( 'order' ); ?>" value="DESC" id="<?php echo $this->get_field_name( 'order_desc' ); ?>"<?php checked( $options['order'], 'DESC', true ); ?> />
<label for="<?php echo $this->get_field_name( 'order_desc' ); ?>"><?php _e( 'Descending' ); ?></label>
</p>
<h3><?php _e( 'Term Display' ); ?></h3>
<p>
<label for="<?php echo $this->get_field_id( 'limit' ); ?>"><?php _e( 'Limit number of terms shown to:' ); ?></label><br />
<input type="text" name="<?php echo $this->get_field_name( 'limit' ); ?>" id="<?php echo $this->get_field_id( 'limit' ); ?>" value="<?php echo intval( $options['limit'] ); ?>" size="3" /><br />
<span class="description"><small><?php _e( 'Enter <strong>0</strong> for no limit.' ); ?></small></span>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'max_name_length' ); ?>"><?php _e( 'Trim long term names to <em>x</em> characters:</label>' ); ?><br />
<input type="text" name="<?php echo $this->get_field_name( 'max_name_length' ); ?>" id="<?php echo $this->get_field_id( 'max_name_length' ); ?>" value="<?php echo intval( $options['max_name_length'] ); ?>" size="3" /><br />
<span class="description"><small><?php _e( 'Enter <strong>0</strong> to show full tag names.' ); ?></small></span>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'cutoff' ); ?>"><?php _e( 'Indicator that term names are trimmed:' ); ?></label><br />
<input type="text" name="<?php echo $this->get_field_name( 'cutoff' ); ?>" id="<?php echo $this->get_field_id( 'cutoff' ); ?>" value="<?php echo esc_attr( $options['cutoff'] ); ?>" size="3" /><br />
<span class="description"><small><?php _e( 'Leave blank to use an elipsis (…).' ); ?></small></span>
<input type="checkbox" name="<?php echo $this->get_field_name( 'hide_empty' ); ?>" id="<?php echo $this->get_field_id( 'hide_empty' ); ?>" value="0"<?php checked( false, $options['hide_empty'], true ); ?> />
<label for="<?php echo $this->get_field_id( 'hide_empty' ); ?>"><?php _e( 'Include terms that aren\'t assigned to any objects (empty terms).' ); ?></label>
</p>
<p>
<input type="checkbox" name="<?php echo $this->get_field_name( 'post_counts' ); ?>" id="<?php echo $this->get_field_id( 'post_counts' ); ?>" value="1"<?php checked( true, $options['post_counts'], true ); ?> />
<label for="<?php echo $this->get_field_id( 'post_counts' ); ?>"><?php _e( 'Display object (post) counts after term names.' ); ?></label>
</p>
<h3><?php _e( 'Include/Exclude Terms' ); ?></h3>
<p>
<label><?php _e( 'Include/exclude terms:' ); ?></label><br />
<input type="radio" name="<?php echo $this->get_field_name( 'incexc' ); ?>" value="include" id="<?php echo $this->get_field_id( 'include' ); ?>"<?php checked( $options['incexc'], 'include', true ); ?> />
<label for="<?php echo $this->get_field_id( 'include' ); ?>"><?php _e( 'Include only the term IDs listed below' ); ?></label><br />
<input type="radio" name="<?php echo $this->get_field_name( 'incexc' ); ?>" value="exclude" id="<?php echo $this->get_field_id( 'exclude' ); ?>"<?php checked( $options['incexc'], 'exclude', true ); ?> />
<label for="<?php echo $this->get_field_id( 'exclude' ); ?>"><?php _e( 'Exclude the term IDs listed below' ); ?></label>
</p>
<p>
<label for="<?php echo $this->get_field_id( 'incexc_ids' ); ?>"><?php _e( 'Term IDs to include/exclude based on above setting:' ); ?></label><br />
<input type="text" name="<?php echo $this->get_field_name( 'incexc_ids' ); ?>" class="widefat code" id="<?php echo $this->get_field_id( 'incexc_ids' ); ?>" value="<?php echo esc_attr( implode( ', ', $options['incexc_ids'] ) ); ?>" /><br />
<span class="description"><small><?php _e( 'Enter comma-separated list of term IDs.' ); ?></small></span>
</p>
<h3><?php _e( 'Advanced' ); ?></h3>
<p>
<label for="<?php echo $this->get_field_id( 'threshold' ); ?>"><?php _e( 'Show terms assigned to at least this many posts:' ); ?></label><br />
<input type="text" name="<?php echo $this->get_field_name( 'threshold' ); ?>" id="<?php echo $this->get_field_id( 'threshold' ); ?>" value="<?php echo intval( $options['threshold'] ); ?>" size="3" /><br />
<span class="description"><small><?php _e( 'Set to <strong>0</strong> to display all terms matching the above criteria.' ); ?></small></span>
</p>
<?php
}
}
/**
** HELPER FUNCTIONS
**/
* Render taxonomy dropdown
* @param array $options
* @param string|int $id
* @uses taxonomy_dropdown_widget_plugin::get_instance
* @return string or false
*/
function taxonomy_dropdown_widget( $options = array(), $id = '' ) {
// Sanitize options
$options = taxonomy_dropdown_widget_plugin::get_instance()->sanitize_options( $options );
return taxonomy_dropdown_widget_plugin::get_instance()->render_dropdown( $options, $id );
}
/**
** LEGACY FUNCTIONS FOR BACKWARDS COMPATIBILITY
**/
if ( ! function_exists( 'generateTagDropdown' ) ) :
* Build tag dropdown based on provided arguments
* @since 1.7
* @uses _deprecated_function
* @uses taxonomy_dropdown_widget_plugin::get_instance
* @return string or false
*/
function generateTagDropdown( $args ) {
_deprecated_function( 'generateTagDropdown', '2.0 of Taxonomy (Tag) Dropdown Widget', 'taxonomy_dropdown_widget' );
// Sanitize options
$options = taxonomy_dropdown_widget_plugin::get_instance()->sanitize_options( $args );
return '<!-- NOTICE: The function used to generate this dropdown list is deprecated as of version 2.0 of Taxonomy Dropdown Widget. You should update your template to use `taxonomy_dropdown_widget()` instead. -->' . "\r\n" . taxonomy_dropdown_widget_plugin::get_instance()->render_dropdown( $options, 'legacy_gtd' );
if ( ! function_exists( 'TDW_direct' ) ) :
* Build tag dropdown based on provided arguments
* @since 1.6
* @uses _deprecated_function
* @uses taxonomy_dropdown_widget_plugin::get_instance
* @return string or false
*/
function TDW_direct( $limit = false, $count = false, $exclude = false ) {
_deprecated_function( 'TDW_direct', '1.7 of Taxonomy (Tag) Dropdown Widget', 'taxonomy_dropdown_widget' );
// Build options array from function parameters
$options = array(
'max_name_length' => $limit,
$options[ 'incexc_ids' ] = $exclude;
}
$options = taxonomy_dropdown_widget_plugin::get_instance()->sanitize_options( $options );
echo '<!-- NOTICE: The function used to generate this dropdown list is deprecated as of version 1.7 of Taxonomy Dropdown Widget. You should update your template to use `taxonomy_dropdown_widget()` instead. -->' . "\r\n" . taxonomy_dropdown_widget_plugin::get_instance()->render_dropdown( $options, 'legacy_tdw' );
if ( ! function_exists( 'makeTagDropdown' ) ) :
* Build tag dropdown based on provided arguments
* @since 1.3
* @uses _deprecated_function
* @uses taxonomy_dropdown_widget_plugin::get_instance
* @return string or false
*/
function makeTagDropdown( $limit = false ) {
_deprecated_function( 'makeTagDropdown', '1.6 of Taxonomy (Tag) Dropdown Widget', 'taxonomy_dropdown_widget' );
// Sanitize options
echo '<!-- NOTICE: The function used to generate this dropdown list is deprecated as of version 1.6 of Taxonomy Dropdown Widget. You should update your template to use `taxonomy_dropdown_widget()` instead. -->' . "\r\n" . taxonomy_dropdown_widget_plugin::get_instance()->render_dropdown( $options, 'legacy_mtd' );