W3cubDocs

/WordPress

WP_Widget_Media::form( array $instance )

Outputs the settings update form.

Description

Note that the widget UI itself is rendered with JavaScript via MediaWidgetControl#render().

See also

Parameters

$instance

(array) (Required) Current settings.

Source

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

final public function form( $instance ) {
		$instance_schema = $this->get_instance_schema();
		$instance        = wp_array_slice_assoc(
			wp_parse_args( (array) $instance, wp_list_pluck( $instance_schema, 'default' ) ),
			array_keys( $instance_schema )
		);

		foreach ( $instance as $name => $value ) : ?>
			<input
				type="hidden"
				data-property="<?php echo esc_attr( $name ); ?>"
				class="media-widget-instance-property"
				name="<?php echo esc_attr( $this->get_field_name( $name ) ); ?>"
				id="<?php echo esc_attr( $this->get_field_id( $name ) ); // Needed specifically by wpWidgets.appendTitle(). ?>"
				value="<?php echo esc_attr( is_array( $value ) ? join( ',', $value ) : strval( $value ) ); ?>"
			/>
			<?php
		endforeach;
	}

Uses

Uses Description
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/formatting.php: esc_attr()

Escaping for HTML attributes.
wp-includes/functions.php: wp_array_slice_assoc()

Extract a slice of an array, given a list of keys.
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.

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/form