You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

400 lines
9.0 KiB

<?php
namespace Elementor;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Elementor image gallery widget.
*
* Elementor widget that displays a set of images in an aligned grid.
*
* @since 1.0.0
*/
class Widget_Image_Gallery extends Widget_Base {
/**
* Get widget name.
*
* Retrieve image gallery widget name.
*
* @since 1.0.0
* @access public
*
* @return string Widget name.
*/
public function get_name() {
return 'image-gallery';
}
/**
* Get widget title.
*
* Retrieve image gallery widget title.
*
* @since 1.0.0
* @access public
*
* @return string Widget title.
*/
public function get_title() {
return __( 'Image Gallery', 'elementor' );
}
/**
* Get widget icon.
*
* Retrieve image gallery widget icon.
*
* @since 1.0.0
* @access public
*
* @return string Widget icon.
*/
public function get_icon() {
return 'eicon-gallery-grid';
}
/**
* Get widget categories.
*
* Retrieve the list of categories the image gallery widget belongs to.
*
* Used to determine where to display the widget in the editor.
*
* @since 1.0.0
* @access public
*
* @return array Widget categories.
*/
public function get_categories() {
return [ 'general-elements' ];
}
/**
* Add lightbox data to image link.
*
* Used to add lightbox data attributes to image link HTML.
*
* @since 1.6.0
* @access public
*
* @param string $link_html Image link HTML.
*
* @return string Image link HTML with lightbox data attributes.
*/
public function add_lightbox_data_to_image_link( $link_html ) {
return preg_replace( '/^<a/', '<a ' . $this->get_render_attribute_string( 'link' ), $link_html );
}
/**
* Register image gallery widget controls.
*
* Adds different input fields to allow the user to change and customize the widget settings.
*
* @since 1.0.0
* @access protected
*/
protected function _register_controls() {
$this->start_controls_section(
'section_gallery',
[
'label' => __( 'Image Gallery', 'elementor' ),
]
);
$this->add_control(
'wp_gallery',
[
'label' => __( 'Add Images', 'elementor' ),
'type' => Controls_Manager::GALLERY,
]
);
$this->add_group_control(
Group_Control_Image_Size::get_type(),
[
'name' => 'thumbnail',
'exclude' => [ 'custom' ],
]
);
$gallery_columns = range( 1, 10 );
$gallery_columns = array_combine( $gallery_columns, $gallery_columns );
$this->add_control(
'gallery_columns',
[
'label' => __( 'Columns', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => 4,
'options' => $gallery_columns,
]
);
$this->add_control(
'gallery_link',
[
'label' => __( 'Link to', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => 'file',
'options' => [
'file' => __( 'Media File', 'elementor' ),
'attachment' => __( 'Attachment Page', 'elementor' ),
'none' => __( 'None', 'elementor' ),
],
]
);
$this->add_control(
'open_lightbox',
[
'label' => __( 'Lightbox', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => 'default',
'options' => [
'default' => __( 'Default', 'elementor' ),
'yes' => __( 'Yes', 'elementor' ),
'no' => __( 'No', 'elementor' ),
],
'condition' => [
'gallery_link' => 'file',
],
]
);
$this->add_control(
'gallery_rand',
[
'label' => __( 'Ordering', 'elementor' ),
'type' => Controls_Manager::SELECT,
'options' => [
'' => __( 'Default', 'elementor' ),
'rand' => __( 'Random', 'elementor' ),
],
'default' => '',
]
);
$this->add_control(
'view',
[
'label' => __( 'View', 'elementor' ),
'type' => Controls_Manager::HIDDEN,
'default' => 'traditional',
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_gallery_images',
[
'label' => __( 'Images', 'elementor' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->add_control(
'image_spacing',
[
'label' => __( 'Spacing', 'elementor' ),
'type' => Controls_Manager::SELECT,
'options' => [
'' => __( 'Default', 'elementor' ),
'custom' => __( 'Custom', 'elementor' ),
],
'prefix_class' => 'gallery-spacing-',
'default' => '',
]
);
$columns_margin = is_rtl() ? '0 0 -{{SIZE}}{{UNIT}} -{{SIZE}}{{UNIT}};' : '0 -{{SIZE}}{{UNIT}} -{{SIZE}}{{UNIT}} 0;';
$columns_padding = is_rtl() ? '0 0 {{SIZE}}{{UNIT}} {{SIZE}}{{UNIT}};' : '0 {{SIZE}}{{UNIT}} {{SIZE}}{{UNIT}} 0;';
$this->add_control(
'image_spacing_custom',
[
'label' => __( 'Image Spacing', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'show_label' => false,
'range' => [
'px' => [
'max' => 100,
],
],
'default' => [
'size' => 15,
],
'selectors' => [
'{{WRAPPER}} .gallery-item' => 'padding:' . $columns_padding,
'{{WRAPPER}} .gallery' => 'margin: ' . $columns_margin,
],
'condition' => [
'image_spacing' => 'custom',
],
]
);
$this->add_group_control(
Group_Control_Border::get_type(),
[
'name' => 'image_border',
'selector' => '{{WRAPPER}} .gallery-item img',
'separator' => 'before',
]
);
$this->add_control(
'image_border_radius',
[
'label' => __( 'Border Radius', 'elementor' ),
'type' => Controls_Manager::DIMENSIONS,
'size_units' => [ 'px', '%' ],
'selectors' => [
'{{WRAPPER}} .gallery-item img' => 'border-radius: {{TOP}}{{UNIT}} {{RIGHT}}{{UNIT}} {{BOTTOM}}{{UNIT}} {{LEFT}}{{UNIT}};',
],
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_caption',
[
'label' => __( 'Caption', 'elementor' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->add_control(
'gallery_display_caption',
[
'label' => __( 'Display', 'elementor' ),
'type' => Controls_Manager::SELECT,
'default' => '',
'options' => [
'' => __( 'Show', 'elementor' ),
'none' => __( 'Hide', 'elementor' ),
],
'selectors' => [
'{{WRAPPER}} .gallery-item .gallery-caption' => 'display: {{VALUE}};',
],
]
);
$this->add_control(
'align',
[
'label' => __( 'Alignment', 'elementor' ),
'type' => Controls_Manager::CHOOSE,
'options' => [
'left' => [
'title' => __( 'Left', 'elementor' ),
'icon' => 'fa fa-align-left',
],
'center' => [
'title' => __( 'Center', 'elementor' ),
'icon' => 'fa fa-align-center',
],
'right' => [
'title' => __( 'Right', 'elementor' ),
'icon' => 'fa fa-align-right',
],
'justify' => [
'title' => __( 'Justified', 'elementor' ),
'icon' => 'fa fa-align-justify',
],
],
'default' => 'center',
'selectors' => [
'{{WRAPPER}} .gallery-item .gallery-caption' => 'text-align: {{VALUE}};',
],
'condition' => [
'gallery_display_caption' => '',
],
]
);
$this->add_control(
'text_color',
[
'label' => __( 'Text Color', 'elementor' ),
'type' => Controls_Manager::COLOR,
'default' => '',
'selectors' => [
'{{WRAPPER}} .gallery-item .gallery-caption' => 'color: {{VALUE}};',
],
'condition' => [
'gallery_display_caption' => '',
],
]
);
$this->add_group_control(
Group_Control_Typography::get_type(),
[
'name' => 'typography',
'scheme' => Scheme_Typography::TYPOGRAPHY_4,
'selector' => '{{WRAPPER}} .gallery-item .gallery-caption',
'condition' => [
'gallery_display_caption' => '',
],
]
);
$this->end_controls_section();
}
/**
* Render image gallery widget output on the frontend.
*
* Written in PHP and used to generate the final HTML.
*
* @since 1.0.0
* @access protected
*/
protected function render() {
$settings = $this->get_settings();
if ( ! $settings['wp_gallery'] ) {
return;
}
$ids = wp_list_pluck( $settings['wp_gallery'], 'id' );
$this->add_render_attribute( 'shortcode', 'ids', implode( ',', $ids ) );
$this->add_render_attribute( 'shortcode', 'size', $settings['thumbnail_size'] );
if ( $settings['gallery_columns'] ) {
$this->add_render_attribute( 'shortcode', 'columns', $settings['gallery_columns'] );
}
if ( $settings['gallery_link'] ) {
$this->add_render_attribute( 'shortcode', 'link', $settings['gallery_link'] );
}
if ( ! empty( $settings['gallery_rand'] ) ) {
$this->add_render_attribute( 'shortcode', 'orderby', $settings['gallery_rand'] );
}
?>
<div class="elementor-image-gallery">
<?php
$this->add_render_attribute( 'link', [
'class' => 'elementor-clickable',
'data-elementor-open-lightbox' => $settings['open_lightbox'],
'data-elementor-lightbox-slideshow' => $this->get_id(),
] );
add_filter( 'wp_get_attachment_link', [ $this, 'add_lightbox_data_to_image_link' ] );
echo do_shortcode( '[gallery ' . $this->get_render_attribute_string( 'shortcode' ) . ']' );
remove_filter( 'wp_get_attachment_link', [ $this, 'add_lightbox_data_to_image_link' ] );
?>
</div>
<?php
}
}