WP_Widget_Media_Video::get_instance_schema() │ public │ WP 4.8.0

Get schema for properties of a widget instance (item).

Method of the class: WP_Widget_Media_Video{}

No Hooks.

Return

Array. Schema for properties.

Usage

$WP_Widget_Media_Video = new WP_Widget_Media_Video();
$WP_Widget_Media_Video->get_instance_schema();

Notes

• See: WP_REST_Controller::get_item_schema()
• See: WP_REST_Controller::get_additional_fields()

Changelog

WP_Widget_Media_Video::get_instance_schema() WP Widget Media Video::get instance schema code ^{WP 6.6.2}

public function get_instance_schema() {

	$schema = array(
		'preload' => array(
			'type'                  => 'string',
			'enum'                  => array( 'none', 'auto', 'metadata' ),
			'default'               => 'metadata',
			'description'           => __( 'Preload' ),
			'should_preview_update' => false,
		),
		'loop'    => array(
			'type'                  => 'boolean',
			'default'               => false,
			'description'           => __( 'Loop' ),
			'should_preview_update' => false,
		),
		'content' => array(
			'type'                  => 'string',
			'default'               => '',
			'sanitize_callback'     => 'wp_kses_post',
			'description'           => __( 'Tracks (subtitles, captions, descriptions, chapters, or metadata)' ),
			'should_preview_update' => false,
		),
	);

	foreach ( wp_get_video_extensions() as $video_extension ) {
		$schema[ $video_extension ] = array(
			'type'        => 'string',
			'default'     => '',
			'format'      => 'uri',
			/* translators: %s: Video extension. */
			'description' => sprintf( __( 'URL to the %s video source file' ), $video_extension ),
		);
	}

	return array_merge( $schema, parent::get_instance_schema() );
}