Gallery Control

Elementor gallery control displays a media select area based on WordPress Galleries. The control allows to select multiple images from the WordPress Media Library.

The control is defined in Control_Gallery class which extends Base_Data_Control class.

Note that when using the control, the type should be set using the \Elementor\Controls_Manager::GALLERY constant.

Arguments

Name Type Default Description
type string gallery The type of the control.
label string The label that appears above of the field.
description string The description that appears below the field.
show_label bool true Whether to display the label.
label_block bool true Whether to display the label in a separate line.
separator string none Set the position of the control separator. Available values are default, before, after and none. default will position the separator depending on the control type. before / after will position the separator before/after the control. none will hide the separator.
default array Default gallery images. An array of images containing the image ID and URL.

Return Value

(array) An array of single image arrays, containing the ID and URL of each image:

  • $id (int) Media id.
  • $url (string) Media url.
[
	[
		'id' => (int),
		'url' => (string)
	],
	[
		'id' => (int),
		'url' => (string)
	],
]

Usage

<?php
class Elementor_Test_Widget extends \Elementor\Widget_Base {

	protected function _register_controls() {

		$this->start_controls_section(
			'content_section',
			[
				'label' => __( 'Content', 'plugin-name' ),
				'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
			]
		);

		$this->add_control(
			'gallery',
			[
				'label' => __( 'Add Images', 'plugin-domain' ),
				'type' => \Elementor\Controls_Manager::GALLERY,
				'default' => [],
			]
		);

		$this->end_controls_section();

	}

	protected function render() {
		$settings = $this->get_settings_for_display();
		foreach ( $settings['gallery'] as $image ) {
			echo '<img src="' . $image['url'] . '">';
		}
	}

	protected function _content_template() {
		?>
		<# _.each( settings.gallery, function( image ) { #>
			<img src="{{ image.url }}">
		<# }); #>
		<?php
	}

}