wppaste
WordPress

WP_Widget_Categories

Since
2.8.0
Source
wp-includes/widgets/class-wp-widget-categories.php:17
Core class used to implement a Categories widget.

Compatibility

WordPress
since 2.8.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 4

Every hook that fires from inside WP_Widget_Categories, in the order it appears in the class, grouped by the method that fires it.

Methods · 4

  • __construct()Sets up a new Categories widget instance.
  • widget()Outputs the content for the current Categories widget instance.
  • update()Handles updating settings for the current Categories widget instance.
  • form()Outputs the settings form for the Categories widget.

Source code

class WP_Widget_Categories extends WP_Widget { 	/**	 * Sets up a new Categories widget instance.	 *	 * @since 2.8.0	 */	public function __construct() {		$widget_ops = array(			'classname'                   => 'widget_categories',			'description'                 => __( 'A list or dropdown of categories.' ),			'customize_selective_refresh' => true,			'show_instance_in_rest'       => true,		);		parent::__construct( 'categories', __( 'Categories' ), $widget_ops );	} 	/**	 * Outputs the content for the current Categories widget instance.	 *	 * @since 2.8.0	 * @since 4.2.0 Creates a unique HTML ID for the `<select>` element	 *              if more than one instance is displayed on the page.	 *	 * @param array $args     Display arguments including 'before_title', 'after_title',	 *                        'before_widget', and 'after_widget'.	 * @param array $instance Settings for the current Categories widget instance.	 */	public function widget( $args, $instance ) {		static $first_dropdown = true; 		$default_title = __( 'Categories' );		$title         = ! empty( $instance['title'] ) ? $instance['title'] : $default_title; 		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base ); 		$count        = ! empty( $instance['count'] ) ? '1' : '0';		$hierarchical = ! empty( $instance['hierarchical'] ) ? '1' : '0';		$dropdown     = ! empty( $instance['dropdown'] ) ? '1' : '0'; 		echo $args['before_widget']; 		if ( $title ) {			echo $args['before_title'] . $title . $args['after_title'];		} 		$cat_args = array(			'orderby'      => 'name',			'show_count'   => $count,			'hierarchical' => $hierarchical,		); 		if ( $dropdown ) {			printf( '<form action="%s" method="get">', esc_url( home_url() ) );			$dropdown_id    = ( $first_dropdown ) ? 'cat' : "{$this->id_base}-dropdown-{$this->number}";			$first_dropdown = false; 			echo '<label class="screen-reader-text" for="' . esc_attr( $dropdown_id ) . '">' . $title . '</label>'; 			$cat_args['show_option_none'] = __( 'Select Category' );			$cat_args['id']               = $dropdown_id; 			/**			 * Filters the arguments for the Categories widget drop-down.			 *			 * @since 2.8.0			 * @since 4.9.0 Added the `$instance` parameter.			 *			 * @see wp_dropdown_categories()			 *			 * @param array $cat_args An array of Categories widget drop-down arguments.			 * @param array $instance Array of settings for the current widget.			 */			wp_dropdown_categories( apply_filters( 'widget_categories_dropdown_args', $cat_args, $instance ) ); 			echo '</form>'; 			ob_start();			?>

Changelog

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/widgets/class-wp-widget-categories.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.