WP_Widget_Media::get_instance_schema() │ public │ WP 4.8.0

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

Method of the class: WP_Widget_Media{}

Return

Array. Schema for properties.

Usage

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

Notes

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

Changelog

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

public function get_instance_schema() {
	$schema = array(
		'attachment_id' => array(
			'type'        => 'integer',
			'default'     => 0,
			'minimum'     => 0,
			'description' => __( 'Attachment post ID' ),
			'media_prop'  => 'id',
		),
		'url'           => array(
			'type'        => 'string',
			'default'     => '',
			'format'      => 'uri',
			'description' => __( 'URL to the media file' ),
		),
		'title'         => array(
			'type'                  => 'string',
			'default'               => '',
			'sanitize_callback'     => 'sanitize_text_field',
			'description'           => __( 'Title for the widget' ),
			'should_preview_update' => false,
		),
	);

	/**
	 * Filters the media widget instance schema to add additional properties.
	 *
	 * @since 4.9.0
	 *
	 * @param array           $schema Instance schema.
	 * @param WP_Widget_Media $widget Widget object.
	 */
	$schema = apply_filters( "widget_{$this->id_base}_instance_schema", $schema, $this );

	return $schema;
}