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

Displays the widget on the front-end.

Description

See also

Parameters

$argsarrayrequired
Display arguments including before_title, after_title, before_widget, and after_widget.
$instancearrayrequired
Saved setting from the database.

Source

public function widget( $args, $instance ) {
	$instance = wp_parse_args( $instance, wp_list_pluck( $this->get_instance_schema(), 'default' ) );

	// Short-circuit if no media is selected.
	if ( ! $this->has_content( $instance ) ) {
		return;
	}

	echo $args['before_widget'];

	/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
	$title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );

	if ( $title ) {
		echo $args['before_title'] . $title . $args['after_title'];
	}

	/**
	 * Filters the media widget instance prior to rendering the media.
	 *
	 * @since 4.8.0
	 *
	 * @param array           $instance Instance data.
	 * @param array           $args     Widget args.
	 * @param WP_Widget_Media $widget   Widget object.
	 */
	$instance = apply_filters( "widget_{$this->id_base}_instance", $instance, $args, $this );

	$this->render_media( $instance );

	echo $args['after_widget'];
}

Hooks

apply_filters( ‘widget_title’, string $title, array $instance, mixed $id_base )

Filters the widget title.

apply_filters( “widget_{$this->id_base}_instance”, array $instance, array $args, WP_Widget_Media $widget )

Filters the media widget instance prior to rendering the media.

Changelog

VersionDescription
4.8.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.