wppaste
WordPress

WP_Widget_Tag_Cloud

Since
2.8.0
Source
wp-includes/widgets/class-wp-widget-tag-cloud.php:17
Core class used to implement a Tag cloud 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 · 3

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

Methods · 5

  • __construct()Sets up a new Tag Cloud widget instance.
  • widget()Outputs the content for the current Tag Cloud widget instance.
  • update()Handles updating settings for the current Tag Cloud widget instance.
  • form()Outputs the Tag Cloud widget settings form.
  • _get_current_taxonomy()Retrieves the taxonomy for the current Tag cloud widget instance.

Source code

class WP_Widget_Tag_Cloud extends WP_Widget { 	/**	 * Sets up a new Tag Cloud widget instance.	 *	 * @since 2.8.0	 */	public function __construct() {		$widget_ops = array(			'description'                 => __( 'A cloud of your most used tags.' ),			'customize_selective_refresh' => true,			'show_instance_in_rest'       => true,		);		parent::__construct( 'tag_cloud', __( 'Tag Cloud' ), $widget_ops );	} 	/**	 * Outputs the content for the current Tag Cloud widget instance.	 *	 * @since 2.8.0	 *	 * @param array $args     Display arguments including 'before_title', 'after_title',	 *                        'before_widget', and 'after_widget'.	 * @param array $instance Settings for the current Tag Cloud widget instance.	 */	public function widget( $args, $instance ) {		$current_taxonomy = $this->_get_current_taxonomy( $instance ); 		if ( ! empty( $instance['title'] ) ) {			$title = $instance['title'];		} else {			if ( 'post_tag' === $current_taxonomy ) {				$title = __( 'Tags' );			} else {				$tax   = get_taxonomy( $current_taxonomy );				$title = $tax->labels->name;			}		} 		$default_title = $title; 		$show_count = ! empty( $instance['count'] ); 		$tag_cloud = wp_tag_cloud(			/**			 * Filters the taxonomy used in the Tag Cloud widget.			 *			 * @since 2.8.0			 * @since 3.0.0 Added taxonomy drop-down.			 * @since 4.9.0 Added the `$instance` parameter.			 *			 * @see wp_tag_cloud()			 *			 * @param array $args     Args used for the tag cloud widget.			 * @param array $instance Array of settings for the current widget.			 */			apply_filters(				'widget_tag_cloud_args',				array(					'taxonomy'   => $current_taxonomy,					'echo'       => false,					'show_count' => $show_count,				),				$instance			)		); 		if ( empty( $tag_cloud ) ) {			return;		} 		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base ); 		echo $args['before_widget'];		if ( $title ) {			echo $args['before_title'] . $title . $args['after_title'];		} 		$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';

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.0.4 tag, from src/wp-includes/widgets/class-wp-widget-tag-cloud.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.