WP_Widget_Custom_HTML::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 Custom HTML widget instance.

Performance profile

How much work a call to WP_Widget_Custom_HTML::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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

85–94

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

Plugin surface

3 hooks

Third-party callbacks on 'widget_title', 'widget_text', 'widget_custom_html_content' 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

Further down the call graph this can also reach query, 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 · 2 distinct outcomes

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

Hooks and filters fired · 3

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

1. 1
   apply_filters( widget_title )filterline 136 (+19 into the body)

   Filters the widget title.

2. 2
   apply_filters( widget_text )filterline 150 (+33 into the body)

   Filters the content of the Text widget.

3. 3
   apply_filters( widget_custom_html_content )filterline 161 (+44 into the body)

   Filters the content of the Custom HTML widget.

Uses · 5

• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• get_queried_object()Retrieves the currently queried object.
• add_filter()Adds a callback function to a filter hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• remove_filter()Removes a callback function from a filter hook.

Source code

View on Trac ↗View on GitHub ↗

117	public function widget( $args, $instance ) {118		global $post;119 120		// Override global $post so filters (and shortcodes) apply in a consistent context.121		$original_post = $post;122		if ( is_singular() ) {123			// Make sure post is always the queried object on singular queries (not from another sub-query that failed to clean up the global $post).124			$post = get_queried_object();125		} else {126			// Nullify the $post global during widget rendering to prevent shortcodes from running with the unexpected context on archive queries.127			$post = null;128		}129 130		// Prevent dumping out all attachments from the media library.131		add_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );132 133		$instance = array_merge( $this->default_instance, $instance );134 135		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */136		$title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );137 138		// Prepare instance data that looks like a normal Text widget.139		$simulated_text_widget_instance = array_merge(140			$instance,141			array(142				'text'   => isset( $instance['content'] ) ? $instance['content'] : '',143				'filter' => false, // Because wpautop is not applied.144				'visual' => false, // Because it wasn't created in TinyMCE.145			)146		);147		unset( $simulated_text_widget_instance['content'] ); // Was moved to 'text' prop.148 149		/** This filter is documented in wp-includes/widgets/class-wp-widget-text.php */150		$content = apply_filters( 'widget_text', $instance['content'], $simulated_text_widget_instance, $this );151 152		/**153		 * Filters the content of the Custom HTML widget.154		 *155		 * @since 4.8.1156		 *157		 * @param string                $content  The widget content.158		 * @param array                 $instance Array of settings for the current widget.159		 * @param WP_Widget_Custom_HTML $widget   Current Custom HTML widget instance.160		 */161		$content = apply_filters( 'widget_custom_html_content', $content, $instance, $this );162 163		// Restore post global.164		$post = $original_post;165		remove_filter( 'shortcode_atts_gallery', array( $this, '_filter_gallery_shortcode_attrs' ) );166 167		// Inject the Text widget's container class name alongside this widget's class name for theme styling compatibility.168		$args['before_widget'] = preg_replace( '/(?<=\sclass=["\'])/', 'widget_text ', $args['before_widget'] );169 170		echo $args['before_widget'];171		if ( ! empty( $title ) ) {172			echo $args['before_title'] . $title . $args['after_title'];173		}174		echo '<div class="textwidget custom-html-widget">'; // The textwidget class is for theme styling compatibility.175		echo $content;176		echo '</div>';177		echo $args['after_widget'];178	}

Changelog

Introduced in 4.8.1. 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 6.9.7 tag, from src/wp-includes/widgets/class-wp-widget-custom-html.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.