W3cubDocs

/WordPress

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

Displays the widget on the front-end.

Description

See also

Parameters

$args

(array) (Required) Display arguments including before_title, after_title, before_widget, and after_widget.

$instance

(array) (Required) Saved setting from the database.

Source

File: wp-includes/widgets/class-wp-widget-media.php 

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 $this     Widget object.
		 */
		$instance = apply_filters( "widget_{$this->id_base}_instance", $instance, $args, $this );

		$this->render_media( $instance );

		echo $args['after_widget'];
	}

Uses

Uses Description
wp-includes/widgets/class-wp-widget-media.php: WP_Widget_Media::has_content()

Whether the widget has content to show.
wp-includes/widgets/class-wp-widget-media.php: WP_Widget_Media::get_instance_schema()

Get schema for properties of a widget instance (item).
wp-includes/widgets/class-wp-widget-media.php: WP_Widget_Media::render_media()

Render the media on the frontend.
wp-includes/widgets/class-wp-widget-media.php: widget_{$this->id_base}_instance

Filters the media widget instance prior to rendering the media.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.
wp-includes/functions.php: wp_list_pluck()

Pluck a certain field out of each object in a list.
wp-includes/widgets/class-wp-widget-pages.php: widget_title

Filters the widget title.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
4.8.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_widget_media/widget