ElementorPro/modules/custom-attributes/module.php
2024-07-07 01:00:30 +02:00

177 lines
5.0 KiB
PHP

<?php
namespace ElementorPro\Modules\CustomAttributes;
use Elementor\Controls_Stack;
use Elementor\Controls_Manager;
use Elementor\Element_Base;
use Elementor\Utils;
use ElementorPro\Base\Module_Base;
use ElementorPro\License\API;
use ElementorPro\Modules\Tiers\Module as Tiers;
use ElementorPro\Plugin;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
class Module extends Module_Base {
const LICENSE_FEATURE_NAME = 'custom-attributes';
public function __construct() {
parent::__construct();
$this->add_actions();
}
public function get_name() {
return 'custom-attributes';
}
private function get_black_list_attributes() {
static $black_list = null;
if ( null === $black_list ) {
$black_list = [ 'id', 'class', 'data-id', 'data-settings', 'data-element_type', 'data-widget_type', 'data-model-cid' ];
/**
* Elementor attributes black list.
*
* Filters the attributes that won't be rendered in the wrapper element.
*
* By default Elementor doesn't render some attributes to prevent things
* from breaking down. This hook allows developers to alter this list of
* attributes.
*
* @since 2.2.0
*
* @param array $black_list A black list of attributes.
*/
$black_list = apply_filters( 'elementor_pro/element/attributes/black_list', $black_list );
}
return $black_list;
}
/**
* @param Element_Base $element
*/
public function replace_go_pro_custom_attributes_controls( Element_Base $element ) {
Plugin::elementor()->controls_manager->remove_control_from_stack( $element->get_unique_name(), [ 'section_custom_attributes_pro', 'custom_attributes_pro' ] );
$this->register_custom_attributes_controls( $element );
}
public function register_custom_attributes_controls( Element_Base $element ) {
$element_name = $element->get_name();
$element->start_controls_section(
'_section_attributes',
[
'label' => esc_html__( 'Attributes', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_ADVANCED,
]
);
$element->add_control(
'_attributes',
[
'label' => esc_html__( 'Custom Attributes', 'elementor-pro' ),
'type' => Controls_Manager::TEXTAREA,
'dynamic' => [
'active' => true,
],
'ai' => [
'active' => false,
],
'placeholder' => esc_html__( 'key|value', 'elementor-pro' ),
'description' => sprintf(
/* translators: %s: The `|` separate char. */
esc_html__( 'Set custom attributes for the wrapper element. Each attribute in a separate line. Separate attribute key from the value using %s character.', 'elementor-pro' ),
'<code>|</code>'
),
'classes' => 'elementor-control-direction-ltr',
]
);
$element->end_controls_section();
}
/**
* @param $element Controls_Stack
* @param $section_id string
*/
public function register_controls( Controls_Stack $element, $section_id ) {
if ( ! $element instanceof Element_Base ) {
return;
}
// Remove Custom CSS Banner (From free version)
if ( 'section_custom_attributes_pro' !== $section_id ) {
return;
}
if ( ! API::is_licence_has_feature( self::LICENSE_FEATURE_NAME, API::BC_VALIDATION_CALLBACK ) ) {
$this->replace_controls_with_upgrade_promotion( $element );
return;
}
$this->replace_go_pro_custom_attributes_controls( $element );
}
/**
* @param $element Element_Base
*/
public function render_attributes( Element_Base $element ) {
$settings = $element->get_settings_for_display();
if ( ! empty( $settings['_attributes'] ) ) {
$attributes = Utils::parse_custom_attributes( $settings['_attributes'], "\n" );
$black_list = $this->get_black_list_attributes();
foreach ( $attributes as $attribute => $value ) {
if ( ! in_array( $attribute, $black_list, true ) ) {
$element->add_render_attribute( '_wrapper', $attribute, $value );
}
}
}
}
protected function add_actions() {
add_action( 'elementor/element/after_section_end', [ $this, 'register_controls' ], 10, 2 );
if ( API::is_licence_has_feature( static::LICENSE_FEATURE_NAME, API::BC_VALIDATION_CALLBACK ) ) {
add_action( 'elementor/element/after_add_attributes', [ $this, 'render_attributes' ] );
}
}
private function replace_controls_with_upgrade_promotion( Element_Base $element ) {
Plugin::elementor()->controls_manager->remove_control_from_stack( $element->get_unique_name(), [ 'section_custom_attributes_pro', 'section_custom_attributes_pro' ] );
$element->start_controls_section(
'section_custom_attributes_promotion',
[
'label' => esc_html__( 'Attributes', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_ADVANCED,
]
);
$element->add_control(
'custom_attributes_promotion',
[
'type' => Controls_Manager::RAW_HTML,
'raw' => Tiers::get_promotion_template( [
'title' => esc_html__( 'Meet Our Attributes', 'elementor-pro' ),
'messages' => [
esc_html__( 'Add custom HTML attributes to any element.', 'elementor-pro' ),
],
'link' => 'https://go.elementor.com/go-pro-advanced-attributes/',
] ),
]
);
$element->end_controls_section();
}
}