WP_Widget_Media::get_instance_schema() – Get schema for properties of a widget instance (item).

You appear to be a bot. Output may be restricted

Description

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

Usage

$array = WP_Widget_Media::get_instance_schema();

Parameters

Returns

array Schema for properties.

Source

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

1 to 36 of 36
  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;
  }
 

 View on GitHub View on Trac