<?php
namespace ElementorPro\Modules\LoopBuilder\Widgets;
use Elementor\Controls_Manager;
use Elementor\Repeater;
use Elementor\Core\Base\Document;
use ElementorPro\Modules\QueryControl\Controls\Template_Query;
use ElementorPro\Modules\QueryControl\Module as QueryControlModule;
use ElementorPro\Modules\LoopBuilder\Documents\Loop as LoopDocument;
use ElementorPro\Modules\LoopBuilder\Module as LoopBuilderModule;
use ElementorPro\Modules\Woocommerce\Module as WoocommerceModule;
use Elementor\Group_Control_Typography;
use Elementor\Group_Control_Text_Shadow;
use Elementor\Group_Control_Text_Stroke;
use ElementorPro\Plugin;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
class Loop_Grid extends Base {
public function get_name() {
return 'loop-grid';
}
public function get_title() {
return esc_html__( 'Loop Grid', 'elementor-pro' );
}
public function get_keywords() {
return [ 'loop', 'dynamic', 'listing', 'archive', 'blog', 'repeater', 'grid', 'products', 'posts', 'portfolio', 'cpt', 'query', 'custom post type' ];
}
public function get_icon() {
return 'eicon-loop-builder';
}
/**
* Get style dependencies.
*
* Retrieve the list of style dependencies the widget requires.
*
* @since 3.24.0
* @access public
*
* @return array Widget style dependencies.
*/
public function get_style_depends(): array {
return [ 'widget-loop-grid' ];
}
public function has_widget_inner_wrapper(): bool {
return ! Plugin::elementor()->experiments->is_feature_active( 'e_optimized_markup' );
}
protected function register_layout_section() {
parent::register_layout_section();
$this->start_injection( [
'of' => 'template_id',
] );
$this->add_responsive_control(
'columns',
[
'label' => esc_html__( 'Columns', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => '3',
'tablet_default' => '2',
'mobile_default' => '1',
'min' => 1,
'max' => 12,
'prefix_class' => 'elementor-grid%s-',
'frontend_available' => true,
'separator' => 'before',
'condition' => [
'template_id!' => '',
],
'selectors' => [
'{{WRAPPER}}' => '--grid-columns: {{VALUE}}',
],
]
);
$this->add_control(
'posts_per_page',
[
'label' => esc_html__( 'Items Per Page', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => 6,
'min' => 1,
'condition' => [
'template_id!' => '',
],
]
);
$this->add_control(
'masonry',
[
'label' => esc_html__( 'Masonry', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
'condition' => [
'columns!' => 1,
'template_id!' => '',
],
'render_type' => 'ui',
'frontend_available' => true,
]
);
$this->add_control(
'equal_height',
[
'label' => esc_html__( 'Equal height', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
'condition' => [
'columns!' => 1,
'template_id!' => '',
'masonry' => '',
],
'selectors' => [
'{{WRAPPER}} .elementor-loop-container' => 'grid-auto-rows: 1fr',
// `.elementor-section-wrap` exists only when editing the loop template.
'{{WRAPPER}} .e-loop-item > .elementor-section, {{WRAPPER}} .e-loop-item > .elementor-section > .elementor-container, {{WRAPPER}} .e-loop-item > .e-con, {{WRAPPER}} .e-loop-item .elementor-section-wrap > .e-con' => 'height: 100%',
],
]
);
$this->add_control(
'alternate_template',
[
'label' => esc_html__( 'Apply an alternate template', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
'condition' => [
'posts_per_page!' => 1,
'template_id!' => '',
'_skin!' => [
LoopBuilderModule::LOOP_POST_TAXONOMY_SKIN_ID,
WoocommerceModule::LOOP_PRODUCT_TAXONOMY_SKIN_ID,
],
],
'render_type' => 'template',
'frontend_available' => true,
'separator' => 'before',
]
);
$repeater = new Repeater();
$repeater->add_control(
'template_id',
[
'label' => esc_html__( 'Choose a template', 'elementor-pro' ),
'type' => Template_Query::CONTROL_ID,
'label_block' => true,
'autocomplete' => [
'object' => QueryControlModule::QUERY_OBJECT_LIBRARY_TEMPLATE,
'query' => [
'post_status' => Document::STATUS_PUBLISH,
'meta_query' => [
[
'key' => Document::TYPE_META_KEY,
'value' => LoopDocument::get_type(),
'compare' => 'IN',
],
],
],
],
'actions' => [
'new' => [
'visible' => true,
'document_config' => [
'type' => LoopDocument::get_type(),
],
'after_action' => 'redirect',
],
'edit' => [
'visible' => true,
'after_action' => 'redirect',
],
],
'frontend_available' => true,
]
);
$repeater->add_control(
'repeat_template',
[
'label' => esc_html__( 'Position in grid', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'condition' => [
'template_id!' => '',
],
]
);
$repeater->add_control(
'repeat_template_note',
[
'type' => Controls_Manager::RAW_HTML,
'raw' => esc_html__( 'Note: Repeat the alternate template once every chosen number of items.', 'elementor-pro' ),
'content_classes' => 'elementor-descriptor',
'condition' => [
'template_id!' => '',
],
]
);
$repeater->add_control(
'show_once',
[
'label' => esc_html__( 'Apply Once', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'default' => 'yes',
'label_off' => esc_html__( 'No', 'elementor-pro' ),
'label_on' => esc_html__( 'Yes', 'elementor-pro' ),
'condition' => [
'template_id!' => '',
],
'render_type' => 'template',
]
);
$repeater->add_responsive_control(
'column_span',
[
'label' => esc_html__( 'Column Span', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => '1',
'options' => [
'1' => esc_html__( '1', 'elementor-pro' ),
'2' => esc_html__( '2', 'elementor-pro' ),
'3' => esc_html__( '3', 'elementor-pro' ),
'4' => esc_html__( '4', 'elementor-pro' ),
'5' => esc_html__( '5', 'elementor-pro' ),
'6' => esc_html__( '6', 'elementor-pro' ),
'7' => esc_html__( '7', 'elementor-pro' ),
'8' => esc_html__( '8', 'elementor-pro' ),
'9' => esc_html__( '9', 'elementor-pro' ),
'10' => esc_html__( '10', 'elementor-pro' ),
'11' => esc_html__( '11', 'elementor-pro' ),
'12' => esc_html__( '12', 'elementor-pro' ),
],
'condition' => [
'template_id!' => '',
],
'selectors' => [
'{{WRAPPER}} {{CURRENT_ITEM}}' => 'grid-column: span min( {{VALUE}}, var(--grid-columns) );',
],
]
);
$repeater->add_control(
'column_span_note',
[
'type' => Controls_Manager::RAW_HTML,
'raw' => esc_html__( 'Note: Item will span across a number of columns.', 'elementor-pro' ),
'content_classes' => 'elementor-descriptor',
'condition' => [
'template_id!' => '',
],
]
);
$repeater->add_control(
'column_span_masonry_note',
[
'type' => Controls_Manager::ALERT,
'alert_type' => 'warning',
'content' => esc_html__( 'Note: The Masonry option combined with Column Span might cause unexpected results and break the layout.', 'elementor-pro' ),
'condition' => [
'column_span!' => '1',
],
]
);
$repeater->add_control(
'static_position',
[
'label' => esc_html__( 'Static item position', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
'condition' => [
'template_id!' => '',
],
'render_type' => 'template',
]
);
$repeater->add_control(
'static_position_note',
[
'type' => Controls_Manager::RAW_HTML,
'raw' => esc_html__( 'Note: Static Items remain in place when new items are added to grid. Other items appear according to query settings.', 'elementor-pro' ),
'content_classes' => 'elementor-descriptor',
'condition' => [
'static_position!' => '',
'template_id!' => '',
],
]
);
$this->add_control(
'alternate_templates',
[
'label' => esc_html__( 'Templates', 'elementor-pro' ),
'type' => Controls_Manager::REPEATER,
'fields' => $repeater->get_controls(),
'title_field' => 'Alternate Template',
'condition' => [
'alternate_template' => 'yes',
'posts_per_page!' => 1,
'template_id!' => '',
],
'default' => [
[
'template_id' => null,
],
],
]
);
// Location for the Edit handle.
$this->add_control(
'edit_handle_selector',
[
'label' => esc_html__( 'Edit Handle Selector', 'elementor-pro' ),
'type' => Controls_Manager::HIDDEN,
'default' => '[data-elementor-type="loop-item"]',
'render_type' => 'none',
'frontend_available' => true,
]
);
$this->end_injection();
}
protected function register_additional_options_section_controls() {
$this->start_controls_section(
'section_additional_options',
[
'label' => esc_html__( 'Additional Options', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_CONTENT,
'condition' => [
'template_id!' => '',
],
]
);
$this->add_control(
'enable_nothing_found_message',
[
'label' => esc_html__( 'Nothing Found Message', 'elementor-pro' ),
'description' => esc_html__( 'Note: This message will appear when no content is loaded in the grid.', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'label_off' => esc_html__( 'Off', 'elementor-pro' ),
'label_on' => esc_html__( 'On', 'elementor-pro' ),
]
);
$this->add_control(
'nothing_found_message_text',
[
'type' => Controls_Manager::TEXTAREA,
'ai' => [
'type' => 'text',
],
'dynamic' => [
'active' => true,
],
'condition' => [
'enable_nothing_found_message' => 'yes',
],
'default' => esc_html__( 'It seems we can’t find what you’re looking for.', 'elementor-pro' ),
]
);
$this->add_responsive_control(
'nothing_found_message_align',
[
'label' => esc_html__( 'Alignment', 'elementor-pro' ),
'type' => Controls_Manager::CHOOSE,
'options' => [
'start' => [
'title' => esc_html__( 'Start', 'elementor-pro' ),
'icon' => 'eicon-text-align-left',
],
'center' => [
'title' => esc_html__( 'Center', 'elementor-pro' ),
'icon' => 'eicon-text-align-center',
],
'end' => [
'title' => esc_html__( 'End', 'elementor-pro' ),
'icon' => 'eicon-text-align-right',
],
],
'selectors' => [
'{{WRAPPER}}' => '--e-loop-nothing-found-message-align: {{VALUE}};',
],
'condition' => [
'enable_nothing_found_message' => 'yes',
],
'render_type' => 'ui',
]
);
$this->add_control(
'nothing_found_message_html_tag',
[
'label' => esc_html__( 'HTML Tag', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'options' => [
'h1' => 'H1',
'h2' => 'H2',
'h3' => 'H3',
'h4' => 'H4',
'h5' => 'H5',
'h6' => 'H6',
'div' => 'div',
'span' => 'span',
],
'default' => 'div',
'condition' => [
'enable_nothing_found_message' => 'yes',
],
]
);
$this->end_controls_section();
}
protected function register_design_layout_controls() {
$this->start_controls_section(
'section_design_layout',
[
'label' => esc_html__( 'Layout', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->add_responsive_control(
'column_gap',
[
'label' => esc_html__( 'Gap between columns', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'custom' ],
'range' => [
'px' => [
'max' => 100,
],
'em' => [
'max' => 10,
],
'rem' => [
'max' => 10,
],
],
'selectors' => [
'{{WRAPPER}}' => '--grid-column-gap: {{SIZE}}{{UNIT}}',
],
]
);
$this->add_responsive_control(
'row_gap',
[
'label' => esc_html__( 'Gap between rows', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'custom' ],
'range' => [
'px' => [
'max' => 100,
],
'em' => [
'max' => 10,
],
'rem' => [
'max' => 10,
],
],
'frontend_available' => true,
'selectors' => [
'{{WRAPPER}}' => '--grid-row-gap: {{SIZE}}{{UNIT}}',
],
]
);
$this->end_controls_section();
}
protected function register_design_nothing_found_message_controls() {
$this->start_controls_section(
'section_nothing_found_message_design',
[
'label' => esc_html__( 'Nothing Found Message', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_STYLE,
'condition' => [
'template_id!' => '',
'enable_nothing_found_message' => 'yes',
],
]
);
$this->add_responsive_control(
'nothing_found_message_space_from_top',
[
'label' => esc_html__( 'Space from top', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', '%', 'em', 'rem', 'custom' ],
'range' => [
'px' => [
'max' => 200,
],
'em' => [
'max' => 20,
],
'rem' => [
'max' => 20,
],
],
'selectors' => [
'{{WRAPPER}}' => '--e-loop-nothing-found-message-space-from-top: {{SIZE}}{{UNIT}}',
],
]
);
$this->add_responsive_control(
'nothing_found_message_space_from_bottom',
[
'label' => esc_html__( 'Space from bottom', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', '%', 'em', 'rem', 'custom' ],
'range' => [
'px' => [
'max' => 200,
],
'em' => [
'max' => 20,
],
'rem' => [
'max' => 20,
],
],
'selectors' => [
'{{WRAPPER}}' => '--e-loop-nothing-found-message-space-from-bottom: {{SIZE}}{{UNIT}}',
],
]
);
$this->add_group_control(
Group_Control_Typography::get_type(),
[
'name' => 'nothing_found_message_typography',
'selector' => '{{WRAPPER}} .e-loop-nothing-found-message__text',
'separator' => 'before',
]
);
$this->add_control(
'nothing_found_message_color',
[
'label' => esc_html__( 'Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}}' => '--e-loop-nothing-found-message-color: {{VALUE}};',
],
]
);
$this->add_group_control(
Group_Control_Text_Shadow::get_type(),
[
'name' => 'nothing_found_message_text_shadow',
'selector' => '{{WRAPPER}} .e-loop-nothing-found-message__text',
]
);
$this->add_group_control(
Group_Control_Text_Stroke::get_type(),
[
'name' => 'nothing_found_message_text_stroke',
'selector' => '{{WRAPPER}} .e-loop-nothing-found-message__text',
]
);
$this->end_controls_section();
}
public static function on_import_update_dynamic_content( array $element_config, array $data, $controls = null ) : array {
if ( isset( $element_config['settings']['template_id'] ) && isset( $data['post_ids'] ) ) {
$element_config['settings']['template_id'] = $data['post_ids'][ $element_config['settings']['template_id'] ];
}
return $element_config;
}
}
|