WP_Widget_Tag_Cloud::widget( array $args, array $instance )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray

Display arguments including 'before_title', 'after_title', 'before_widget', and 'after_widget'.

$instancearray

Settings for the current Tag Cloud widget instance.

Performance profile

How much work a call to WP_Widget_Tag_Cloud::widget() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_terms().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

28–89

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 99.

Plugin surface

3 hooks

Third-party callbacks on 'widget_tag_cloud_args', 'widget_title', 'navigation_widgets_format' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_terms()one call below WP_Widget_Tag_Cloud::widget()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Widget_Tag_Cloud::widget() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while WP_Widget_Tag_Cloud::widget() runs, in this order:

1. 1
   apply_filters( widget_tag_cloud_args )filterline 73 (+31 into the body)

   Filters the taxonomy used in the Tag Cloud widget.

2. 2
   apply_filters( widget_title )filterline 89 (+47 into the body)

   Filters the widget title.

3. 3
   apply_filters( navigation_widgets_format )filterline 99 (+57 into the body)

   Filters the HTML format of widgets with navigation links.

Uses · 7

• __()Retrieves the translation of $text.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• wp_tag_cloud()Displays a tag cloud.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• current_theme_supports()Checks a theme's support for a given feature.
• esc_attr()Escaping for HTML attributes.
• WP_Widget_Tag_Cloud::_get_current_taxonomy()Retrieves the taxonomy for the current Tag cloud widget instance.

Source code

View on Trac ↗View on GitHub ↗

42	public function widget( $args, $instance ) {43		$current_taxonomy = $this->_get_current_taxonomy( $instance );44 45		if ( ! empty( $instance['title'] ) ) {46			$title = $instance['title'];47		} else {48			if ( 'post_tag' === $current_taxonomy ) {49				$title = __( 'Tags' );50			} else {51				$tax   = get_taxonomy( $current_taxonomy );52				$title = $tax->labels->name;53			}54		}55 56		$default_title = $title;57 58		$show_count = ! empty( $instance['count'] );59 60		$tag_cloud = wp_tag_cloud(61			/**62			 * Filters the taxonomy used in the Tag Cloud widget.63			 *64			 * @since 2.8.065			 * @since 3.0.0 Added taxonomy drop-down.66			 * @since 4.9.0 Added the `$instance` parameter.67			 *68			 * @see wp_tag_cloud()69			 *70			 * @param array $args     Args used for the tag cloud widget.71			 * @param array $instance Array of settings for the current widget.72			 */73			apply_filters(74				'widget_tag_cloud_args',75				array(76					'taxonomy'   => $current_taxonomy,77					'echo'       => false,78					'show_count' => $show_count,79				),80				$instance81			)82		);83 84		if ( empty( $tag_cloud ) ) {85			return;86		}87 88		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */89		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base );90 91		echo $args['before_widget'];92		if ( $title ) {93			echo $args['before_title'] . $title . $args['after_title'];94		}95 96		$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';97 98		/** This filter is documented in wp-includes/widgets/class-wp-nav-menu-widget.php */99		$format = apply_filters( 'navigation_widgets_format', $format );100 101		if ( 'html5' === $format ) {102			// The title may be filtered: Strip out HTML and make sure the aria-label is never empty.103			$title      = trim( strip_tags( $title ) );104			$aria_label = $title ? $title : $default_title;105			echo '<nav aria-label="' . esc_attr( $aria_label ) . '">';106		}107 108		echo '<div class="tagcloud">';109 110		echo $tag_cloud;111 112		echo "</div>\n";113 114		if ( 'html5' === $format ) {115			echo '</nav>';116		}117 118		echo $args['after_widget'];119	}

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-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.