WP_Widget_Media::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

Saved setting from the database.

Performance profile

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

18–54

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

Plugin surface

2 hooks

Third-party callbacks on 'widget_title', 'widget_{$this->id_base}_instance' 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

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_Media::widget() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while WP_Widget_Media::widget() runs, in this order:

1. 1
   apply_filters( widget_title )filterline 240 (+11 into the body)

   Filters the widget title.

2. 2
   apply_filters( widget_{$this->id_base}_instance )filterline 255 (+26 into the body)

   Filters the media widget instance prior to rendering the media.

Uses · 6

• wp_parse_args()Merges user defined arguments into defaults array.
• wp_list_pluck()Plucks a certain field out of each object or array in an array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Widget_Media::get_instance_schema()Get schema for properties of a widget instance (item).
• WP_Widget_Media::has_content()Whether the widget has content to show.
• WP_Widget_Media::render_media()Render the media on the frontend.

Source code

View on Trac ↗View on GitHub ↗

229	public function widget( $args, $instance ) {230		$instance = wp_parse_args( $instance, wp_list_pluck( $this->get_instance_schema(), 'default' ) );231 232		// Short-circuit if no media is selected.233		if ( ! $this->has_content( $instance ) ) {234			return;235		}236 237		echo $args['before_widget'];238 239		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */240		$title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );241 242		if ( $title ) {243			echo $args['before_title'] . $title . $args['after_title'];244		}245 246		/**247		 * Filters the media widget instance prior to rendering the media.248		 *249		 * @since 4.8.0250		 *251		 * @param array           $instance Instance data.252		 * @param array           $args     Widget args.253		 * @param WP_Widget_Media $widget   Widget object.254		 */255		$instance = apply_filters( "widget_{$this->id_base}_instance", $instance, $args, $this );256 257		$this->render_media( $instance );258 259		echo $args['after_widget'];260	}

Changelog

Introduced in 4.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-media.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.