Taxonomy List Widget Plugin

Since I first wrote the Tag Dropdown Widget plugin upon which this plugin is based (in November 2009), WordPress introduced custom taxonomies and, as more-fully discussed below, saw a new widgets API overtake its predecessor. As part of the widgets-API-related rewrite, I expanded the plugin to support non-hierarchical custom taxonomies, which necessitated a new name for the plugin.

When I first wrote the Tag Dropdown Widget plugin, which I later forked to create the Tag List Widget plugin, WordPress was amidst a change in how widgets were managed. I decided to utilize the old widget methods to ensure the greatest compatibility at the time. In the nearly two years since I released the first version of this plugin, the new widget system has been widely adopted, putting this plugin at a disadvantage. So, I rewrote the plugin to use the new widget API and added support for non-hierarchical taxonomies other than just post tags.

As discussed above, WordPress’ widget system has changed drastically since I first released this plugin. To facilitate multiple uses of the same widget while allowing each to maintain its own set of options, the manner for storing widget options changed. As a result, there is no practical way to transition a widget’s options from version 0.3.1 to 1.0.

Insert the function <?php if( function_exists( 'taxonomy_list_widget' ) ) echo taxonomy_list_widget( $args, $id ); ?> where the list should appear, specifying $args as an array of arguments and, optionally, $id as a string uniquely identifying this list.

• taxonomy – slug of taxonomy for list. Defaults to post_tag.
• select_name – name of first (default) option in the list. Defaults to Select Tag.
• max_name_length – integer representing maximum length of term name to display. Set to 0 to show full names. Defaults to 0.
• cutoff – string indicating that a term name has been cutoff based on the max_name_length setting. Defaults to an ellipsis (…).
• limit – integer specifying maximum number of terms to retrieve. Set to 0 for no limit. Defaults to 0.
• orderby – either name to order by term name or count to order by the number of posts associated with the given term. Defaults to name.
• order – either ASC for ascending order or DESC for descending order. Defaults to ASC.
• threshold – integer specifying the minimum number of posts to which a term must be assigned to be included in the list. Set to 0 for now threshold. Defaults to 0.
• incexc – include or exclude to either include or exclude the terms whose IDs are included in incexc_ids. By default, this restriction is not enabled.
• incexc_ids – comma-separated list of term IDs to either include or exclude based on the incexc setting.
• hide_empty – set to false to include in the list any terms that haven’t been assigned to any objects (i.e. unused tags). Defaults to true.
• post_counts – set to true to include post counts after term names. Defaults to false.
• delimiter – sets list style. Native options are ul, ol, and nl for bulleted list, numbered list, and line breaks, respectively. By passing an array with keys before_list, after_list, before_item, and after_item, you can completely customize the list style.
• rel – either dofollow or nofollow. Can still use taxonomy_list_widget_link_rel filter to specify link relationship.

Version 1.0 represents a complete rewrite of the original Tag List Widget plugin. As part of the rewrite, all prior functions for generating tag lists were deprecated, or marked as obsolete, because they are unable to access the full complement of features introduced in version 1.0. While the functions still exist, their capabilities are extremely limited and they should not be replaced with taxonomy_list_widget().

Term IDs can be obtained in a variety of ways. The easiest is to visit the taxonomy term editor (Post Tags, found under Posts, for example) and, while hovering over the term’s name, looking at your browser’s status bar. At the very end of the address shown in the status bar, the term ID will follow the text “tag_ID.”

You can also obtain the term ID by clicking the edit link below any term’s name in the Post Tags page. Next, look at your browser’s address bar. At the very end of the address, the term ID will follow the text “tag_ID.”

This plugin relies on WordPress’ get_terms function (https://codex.wordpress.org/Function_Reference/get_terms). To modify the arguments passed to this function, use the taxonomy_list_widget_options filter to specify any of the arguments discussed in the Codex page for get_terms.

To make targeting a specific filter reference possible should you use multiple instances of the list (multiple widgets, use of the taxonomy_list_widget function, or some combination thereof), the filter provides a second argument, $id, that is either the numeric ID of the widget’s instance or the string provided as the second argument to taxonomy_list_widget.