WP_Widget_Media_Gallery

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 1

Every hook that fires from inside WP_Widget_Media_Gallery, in the order it appears in the class, grouped by the method that fires it.

Methods · 6

• __construct()Constructor.
• get_instance_schema()Get schema for properties of a widget instance (item).
• render_media()Render the media on the frontend.
• enqueue_admin_scripts()Loads the required media files for the media manager and scripts for media widgets.
• render_control_template_scripts()Render form template scripts.
• has_content()Whether the widget has content to show.

Source code

View on Trac ↗View on GitHub ↗

18class WP_Widget_Media_Gallery extends WP_Widget_Media {19 20	/**21	 * Constructor.22	 *23	 * @since 4.9.024	 */25	public function __construct() {26		parent::__construct(27			'media_gallery',28			__( 'Gallery' ),29			array(30				'description' => __( 'Displays an image gallery.' ),31				'mime_type'   => 'image',32			)33		);34 35		$this->l10n = array_merge(36			$this->l10n,37			array(38				'no_media_selected' => __( 'No images selected' ),39				'add_media'         => _x( 'Add Images', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),40				'replace_media'     => '',41				'edit_media'        => _x( 'Edit Gallery', 'label for button in the gallery widget; should not be longer than ~13 characters long' ),42			)43		);44	}45 46	/**47	 * Get schema for properties of a widget instance (item).48	 *49	 * @since 4.9.050	 *51	 * @see WP_REST_Controller::get_item_schema()52	 * @see WP_REST_Controller::get_additional_fields()53	 * @link https://core.trac.wordpress.org/ticket/3557454	 *55	 * @return array Schema for properties.56	 */57	public function get_instance_schema() {58		$schema = array(59			'title'          => array(60				'type'                  => 'string',61				'default'               => '',62				'sanitize_callback'     => 'sanitize_text_field',63				'description'           => __( 'Title for the widget' ),64				'should_preview_update' => false,65			),66			'ids'            => array(67				'type'              => 'array',68				'items'             => array(69					'type' => 'integer',70				),71				'default'           => array(),72				'sanitize_callback' => 'wp_parse_id_list',73			),74			'columns'        => array(75				'type'    => 'integer',76				'default' => 3,77				'minimum' => 1,78				'maximum' => 9,79			),80			'size'           => array(81				'type'    => 'string',82				'enum'    => array_merge( get_intermediate_image_sizes(), array( 'full', 'custom' ) ),83				'default' => 'thumbnail',84			),85			'link_type'      => array(86				'type'                  => 'string',87				'enum'                  => array( 'post', 'file', 'none' ),88				'default'               => 'post',89				'media_prop'            => 'link',90				'should_preview_update' => false,91			),92			'orderby_random' => array(93				'type'                  => 'boolean',94				'default'               => false,95				'media_prop'            => '_orderbyRandom',96				'should_preview_update' => false,97			),

Changelog

Introduced in 4.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/widgets/class-wp-widget-media-gallery.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.