PluginProbe
Elementor Website Builder – more than just a page builder / 3.0.1
Elementor Website Builder – more than just a page builder v3.0.1
4.3.0-beta2 4.3.0-beta1 4.2.4 4.2.3 4.2.2 4.2.1 4.2.0 4.1.5 4.2.0-beta2 4.2.0-dev2 4.2.0-beta1 4.1.4 4.1.3 4.1.2 4.1.1 4.1.0 4.1.0-beta3 4.1.0-dev3 4.0.9 4.1.0-beta2 4.1.0-dev2 4.0.8 4.1.0-beta1 4.1.0-dev1 4.0.7 All 451 releases
← All changes | includes/base/controls-stack.php +146 -657 4.1.43.0.1 View file →
@@ -2,11 +2,9 @@
2 2 namespace Elementor;
3 3
4 4 use Elementor\Core\Base\Base_Object;
5 5 use Elementor\Core\DynamicTags\Manager;
6 -use Elementor\Core\Breakpoints\Manager as Breakpoints_Manager;
7 -use Elementor\Core\Frontend\Performance;
8 -use Elementor\Utils;
6 +use Elementor\Core\Schemes\Manager as Schemes_Manager;
9 7
10 8 if ( ! defined( 'ABSPATH' ) ) {
11 9 exit; // Exit if accessed directly.
12 10 }
@@ -23,24 +21,18 @@
23 21 abstract class Controls_Stack extends Base_Object {
24 22
25 23 /**
26 24 * Responsive 'desktop' device name.
27 - *
28 - * @deprecated 3.4.0
29 25 */
30 26 const RESPONSIVE_DESKTOP = 'desktop';
31 27
32 28 /**
33 29 * Responsive 'tablet' device name.
34 - *
35 - * @deprecated 3.4.0
36 30 */
37 31 const RESPONSIVE_TABLET = 'tablet';
38 32
39 33 /**
40 34 * Responsive 'mobile' device name.
41 - *
42 - * @deprecated 3.4.0
43 35 */
44 36 const RESPONSIVE_MOBILE = 'mobile';
45 37
46 38 /**
@@ -91,22 +83,8 @@
91 83 */
92 84 private $config;
93 85
94 86 /**
95 - * The additional configuration.
96 - *
97 - * Holds additional configuration that has been set using `set_config` method.
98 - * The `config` property is not modified directly while using the method because
99 - * it's used to check whether the initial config already loaded (in `get_config`).
100 - * After the initial config loaded, the additional config is merged into it.
101 - *
102 - * @access private
103 - *
104 - * @var null|array
105 - */
106 - private $additional_config = [];
107 -
108 - /**
109 87 * Current section.
110 88 *
111 89 * Holds the current section while inserting a set of controls sections.
112 90 *
@@ -159,20 +137,8 @@
159 137 */
160 138 private $settings_sanitized = false;
161 139
162 140 /**
163 - * Element render attributes.
164 - *
165 - * Holds all the render attributes of the element. Used to store data like
166 - * the HTML class name and the class value, or HTML element ID name and value.
167 - *
168 - * @access private
169 - *
170 - * @var array
171 - */
172 - private $render_attributes = [];
173 -
174 - /**
175 141 * Get element name.
176 142 *
177 143 * Retrieve the element name.
178 144 *
@@ -223,29 +189,12 @@
223 189 *
224 190 * @return string The converted ID.
225 191 */
226 192 public function get_id_int() {
227 - /** We ignore possible notices, in order to support elements created prior to v1.8.0 and might include
228 - * non-base 16 characters as part of their ID.
229 - */
230 - return @hexdec( (string) $this->id );
193 + return hexdec( $this->id );
231 194 }
232 195
233 196 /**
234 - * Get widget number.
235 - *
236 - * Get the first three numbers of the element converted ID.
237 - *
238 - * @since 3.16
239 - * @access public
240 - *
241 - * @return string The widget number.
242 - */
243 - public function get_widget_number(): string {
244 - return substr( $this->get_id_int(), 0, 3 );
245 - }
246 -
247 - /**
248 197 * Get the type.
249 198 *
250 199 * Retrieve the type, e.g. 'stack', 'section', 'widget' etc.
251 200 *
@@ -269,8 +218,35 @@
269 218 return true;
270 219 }
271 220
272 221 /**
222 + * Get items.
223 + *
224 + * Utility method that receives an array with a needle and returns all the
225 + * items that match the needle. If needle is not defined the entire haystack
226 + * will be returned.
227 + *
228 + * @since 1.4.0
229 + * @deprecated 2.3.0 Use `Controls_Stack::get_items()` instead
230 + * @access protected
231 + * @static
232 + *
233 + * @param array $haystack An array of items.
234 + * @param string $needle Optional. Needle. Default is null.
235 + *
236 + * @return mixed The whole haystack or the needle from the haystack when requested.
237 + */
238 + protected static function _get_items( array $haystack, $needle = null ) {
239 + _deprecated_function( __METHOD__, '2.3.0', __CLASS__ . '::get_items()' );
240 +
241 + if ( $needle ) {
242 + return isset( $haystack[ $needle ] ) ? $haystack[ $needle ] : null;
243 + }
244 +
245 + return $haystack;
246 + }
247 +
248 + /**
273 249 * Get current section.
274 250 *
275 251 * When inserting new controls, this method will retrieve the current section.
276 252 *
@@ -311,26 +287,9 @@
311 287 *
312 288 * @return mixed Controls list.
313 289 */
314 290 public function get_controls( $control_id = null ) {
315 - $stack = $this->get_stack();
316 -
317 - if ( null !== $control_id ) {
318 - $control_data = self::get_items( $stack['controls'], $control_id );
319 - if ( null === $control_data && ! empty( $stack['style_controls'] ) ) {
320 - $control_data = self::get_items( $stack['style_controls'], $control_id );
321 - }
322 -
323 - return $control_data;
324 - }
325 -
326 - $controls = $stack['controls'];
327 -
328 - if ( Performance::is_use_style_controls() && ! empty( $stack['style_controls'] ) ) {
329 - $controls += $stack['style_controls'];
330 - }
331 -
332 - return self::get_items( $controls, $control_id );
291 + return self::get_items( $this->get_stack()['controls'], $control_id );
333 292 }
334 293
335 294 /**
336 295 * Get active controls.
@@ -349,10 +308,10 @@
349 308 * @param array $settings Optional. Controls settings. Default is null.
350 309 *
351 310 * @return array Active controls.
352 311 */
353 - public function get_active_controls( ?array $controls = null, ?array $settings = null ) {
354 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '3.0.0' );
312 + public function get_active_controls( array $controls = null, array $settings = null ) {
313 + // _deprecated_function( __METHOD__, '3.0.0' );
355 314
356 315 if ( ! $controls ) {
357 316 $controls = $this->get_controls();
358 317 }
@@ -364,9 +323,9 @@
364 323 $active_controls = array_reduce(
365 324 array_keys( $controls ), function( $active_controls, $control_key ) use ( $controls, $settings ) {
366 325 $control = $controls[ $control_key ];
367 326
368 - if ( $this->is_control_visible( $control, $settings, $controls ) ) {
327 + if ( $this->is_control_visible( $control, $settings ) ) {
369 328 $active_controls[ $control_key ] = $control;
370 329 }
371 330
372 331 return $active_controls;
@@ -394,9 +353,9 @@
394 353 * Add new control to stack.
395 354 *
396 355 * Register a single control to allow the user to set/update data.
397 356 *
398 - * This method should be used inside `register_controls()`.
357 + * This method should be used inside `_register_controls()`.
399 358 *
400 359 * @since 1.4.0
401 360 * @access public
402 361 *
@@ -439,58 +398,14 @@
439 398 }
440 399
441 400 unset( $options['position'] );
442 401
443 - if ( $this->current_popover ) {
444 - $args['popover'] = [];
445 -
446 - if ( ! $this->current_popover['initialized'] ) {
447 - $args['popover']['start'] = true;
448 -
449 - $this->current_popover['initialized'] = true;
450 - }
451 - }
452 -
453 - if ( Performance::should_optimize_controls() ) {
454 - $ui_controls = [
455 - Controls_Manager::RAW_HTML,
456 - Controls_Manager::DIVIDER,
457 - Controls_Manager::HEADING,
458 - Controls_Manager::BUTTON,
459 - Controls_Manager::ALERT,
460 - Controls_Manager::NOTICE,
461 - Controls_Manager::DEPRECATED_NOTICE,
402 + if ( $this->current_popover && ! $this->current_popover['initialized'] ) {
403 + $args['popover'] = [
404 + 'start' => true,
462 405 ];
463 406
464 - if ( ! empty( $args['type'] ) && ! empty( $args['section'] ) && in_array( $args['type'], $ui_controls ) ) {
465 - $args = [
466 - 'type' => $args['type'],
467 - 'section' => $args['section'],
468 - ];
469 - }
470 -
471 - unset(
472 - $args['label_block'],
473 - $args['label'],
474 - $args['title'],
475 - $args['tab'],
476 - $args['options'],
477 - $args['placeholder'],
478 - $args['separator'],
479 - $args['size_units'],
480 - $args['range'],
481 - $args['toggle'],
482 - $args['ai'],
483 - $args['classes'],
484 - $args['style_transfer'],
485 - $args['show_label'],
486 - $args['description'],
487 - $args['label_on'],
488 - $args['label_off'],
489 - $args['labels'],
490 - $args['handles'],
491 - $args['editor_available'],
492 - );
407 + $this->current_popover['initialized'] = true;
493 408 }
494 409
495 410 return Plugin::$instance->controls_manager->add_control_to_stack( $this, $id, $args, $options );
496 411 }
@@ -612,12 +527,12 @@
612 527
613 528 $position = array_merge( $default_position, $position );
614 529
615 530 if (
616 - ( 'control' === $position['type'] && in_array( $position['at'], [ 'start', 'end' ], true ) ) ||
617 - ( 'section' === $position['type'] && in_array( $position['at'], [ 'before', 'after' ], true ) )
531 + 'control' === $position['type'] && in_array( $position['at'], [ 'start', 'end' ], true ) ||
532 + 'section' === $position['type'] && in_array( $position['at'], [ 'before', 'after' ], true )
618 533 ) {
619 - _doing_it_wrong( sprintf( '%s::%s', get_called_class(), __FUNCTION__ ), 'Invalid position arguments. Use `before` / `after` for control or `start` / `end` for section.', '1.7.0' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
534 + _doing_it_wrong( sprintf( '%s::%s', get_called_class(), __FUNCTION__ ), 'Invalid position arguments. Use `before` / `after` for control or `start` / `end` for section.', '1.7.0' );
620 535
621 536 return false;
622 537 }
623 538
@@ -637,13 +552,13 @@
637 552
638 553 $controls_keys = array_keys( $registered_controls );
639 554
640 555 while ( Controls_Manager::SECTION !== $registered_controls[ $controls_keys[ $target_section_index ] ]['type'] ) {
641 - --$target_section_index;
556 + $target_section_index--;
642 557 }
643 558
644 559 if ( 'section' === $position['type'] ) {
645 - ++$target_control_index;
560 + $target_control_index++;
646 561
647 562 if ( 'end' === $position['at'] ) {
648 563 while ( Controls_Manager::SECTION !== $registered_controls[ $controls_keys[ $target_control_index ] ]['type'] ) {
649 564 if ( ++$target_control_index >= count( $registered_controls ) ) {
@@ -655,9 +570,9 @@
655 570
656 571 $target_control = $registered_controls[ $controls_keys[ $target_control_index ] ];
657 572
658 573 if ( 'after' === $position['at'] ) {
659 - ++$target_control_index;
574 + $target_control_index++;
660 575 }
661 576
662 577 $section_id = $registered_controls[ $controls_keys[ $target_section_index ] ]['name'];
663 578
@@ -737,9 +652,9 @@
737 652
738 653 $controls_keys = array_keys( $registered_controls );
739 654
740 655 while ( true ) {
741 - ++$section_index;
656 + $section_index++;
742 657
743 658 if ( ! isset( $controls_keys[ $section_index ] ) ) {
744 659 break;
745 660 }
@@ -750,9 +665,9 @@
750 665 break;
751 666 }
752 667
753 668 $section_controls[ $control_key ] = $registered_controls[ $control_key ];
754 - }
669 + };
755 670
756 671 return $section_controls;
757 672 }
758 673
@@ -774,9 +689,9 @@
774 689 final public function add_group_control( $group_name, array $args = [], array $options = [] ) {
775 690 $group = Plugin::$instance->controls_manager->get_control_groups( $group_name );
776 691
777 692 if ( ! $group ) {
778 - wp_die( sprintf( '%s::%s: Group "%s" not found.', get_called_class(), __FUNCTION__, $group_name ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
693 + wp_die( sprintf( '%s::%s: Group "%s" not found.', get_called_class(), __FUNCTION__, $group_name ) );
779 694 }
780 695
781 696 $group->add_controls( $this, $args, $options );
782 697 }
@@ -781,8 +696,30 @@
781 696 $group->add_controls( $this, $args, $options );
782 697 }
783 698
784 699 /**
700 + * Get scheme controls.
701 + *
702 + * Retrieve all the controls that use schemes.
703 + *
704 + * @since 1.4.0
705 + * @access public
706 + * @deprecated 3.0.0
707 + *
708 + * @return array Scheme controls.
709 + */
710 + final public function get_scheme_controls() {
711 + // _deprecated_function( __METHOD__, '3.0.0' );
712 + $enabled_schemes = Schemes_Manager::get_enabled_schemes();
713 +
714 + return array_filter(
715 + $this->get_controls(), function( $control ) use ( $enabled_schemes ) {
716 + return ( ! empty( $control['scheme'] ) && in_array( $control['scheme']['type'], $enabled_schemes ) );
717 + }
718 + );
719 + }
720 +
721 + /**
785 722 * Get style controls.
786 723 *
787 724 * Retrieve style controls for all active controls or, when requested, from
788 725 * a specific set of controls.
@@ -796,10 +733,10 @@
796 733 * @param array $settings Optional. Controls settings. Default is null.
797 734 *
798 735 * @return array Style controls.
799 736 */
800 - final public function get_style_controls( ?array $controls = null, ?array $settings = null ) {
801 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '3.0.0' );
737 + final public function get_style_controls( array $controls = null, array $settings = null ) {
738 + // _deprecated_function( __METHOD__, '3.0.0' );
802 739
803 740 $controls = $this->get_active_controls( $controls, $settings );
804 741
805 742 $style_controls = [];
@@ -848,15 +785,9 @@
848 785 /**
849 786 * Add new responsive control to stack.
850 787 *
851 788 * Register a set of controls to allow editing based on user screen size.
852 - * This method registers one or more controls per screen size/device, depending on the current Responsive Control
853 - * Duplication Mode. There are 3 control duplication modes:
854 - * * 'off' - Only a single control is generated. In the Editor, this control is duplicated in JS.
855 - * * 'on' - Multiple controls are generated, one control per enabled device/breakpoint + a default/desktop control.
856 - * * 'dynamic' - If the control includes the `'dynamic' => 'active' => true` property - the control is duplicated,
857 - * once for each device/breakpoint + default/desktop.
858 - * If the control doesn't include the `'dynamic' => 'active' => true` property - the control is not duplicated.
789 + * This method registers three screen sizes: Desktop, Tablet and Mobile.
859 790 *
860 791 * @since 1.4.0
861 792 * @access public
862 793 *
@@ -867,15 +798,14 @@
867 798 */
868 799 final public function add_responsive_control( $id, array $args, $options = [] ) {
869 800 $args['responsive'] = [];
870 801
871 - $active_breakpoints = Plugin::$instance->breakpoints->get_active_breakpoints();
802 + $devices = [
803 + self::RESPONSIVE_DESKTOP,
804 + self::RESPONSIVE_TABLET,
805 + self::RESPONSIVE_MOBILE,
806 + ];
872 807
873 - $devices = Plugin::$instance->breakpoints->get_active_devices_list( [
874 - 'reverse' => true,
875 - 'desktop_first' => true,
876 - ] );
877 -
878 808 if ( isset( $args['devices'] ) ) {
879 809 $devices = array_intersect( $devices, $args['devices'] );
880 810
881 811 $args['responsive']['devices'] = $devices;
@@ -882,46 +812,8 @@
882 812
883 813 unset( $args['devices'] );
884 814 }
885 815
886 - $control_to_check = $args;
887 -
888 - if ( ! empty( $options['overwrite'] ) ) {
889 - $existing_control = Plugin::$instance->controls_manager->get_control_from_stack( $this->get_unique_name(), $id );
890 -
891 - if ( ! is_wp_error( $existing_control ) ) {
892 - $control_to_check = $existing_control;
893 - }
894 - }
895 -
896 - $responsive_duplication_mode = Plugin::$instance->breakpoints->get_responsive_control_duplication_mode();
897 - $additional_breakpoints_active = Plugin::$instance->experiments->is_feature_active( 'additional_custom_breakpoints' );
898 - $control_is_dynamic = ! empty( $control_to_check['dynamic']['active'] );
899 - $is_frontend_available = ! empty( $control_to_check['frontend_available'] );
900 - $has_prefix_class = ! empty( $control_to_check['prefix_class'] );
901 -
902 - // If the new responsive controls experiment is active, create only one control - duplicates per device will
903 - // be created in JS in the Editor.
904 - if (
905 - $additional_breakpoints_active
906 - && ( 'off' === $responsive_duplication_mode || ( 'dynamic' === $responsive_duplication_mode && ! $control_is_dynamic ) )
907 - // Some responsive controls need responsive settings to be available to the widget handler, even when empty.
908 - && ! $is_frontend_available
909 - && ! $has_prefix_class
910 - ) {
911 - $args['is_responsive'] = true;
912 -
913 - if ( ! empty( $options['overwrite'] ) ) {
914 - $this->update_control( $id, $args, [
915 - 'recursive' => ! empty( $options['recursive'] ),
916 - ] );
917 - } else {
918 - $this->add_control( $id, $args, $options );
919 - }
920 -
921 - return;
922 - }
923 -
924 816 if ( isset( $args['default'] ) ) {
925 817 $args['desktop_default'] = $args['default'];
926 818
927 819 unset( $args['default'] );
@@ -929,16 +821,8 @@
929 821
930 822 foreach ( $devices as $device_name ) {
931 823 $control_args = $args;
932 824
933 - // Set parent using the name from previous iteration.
934 - if ( isset( $control_name ) ) {
935 - // If $control_name end with _widescreen use desktop name instead.
936 - $control_args['parent'] = '_widescreen' === substr( $control_name, -strlen( '_widescreen' ) ) ? $id : $control_name;
937 - } else {
938 - $control_args['parent'] = null;
939 - }
940 -
941 825 if ( isset( $control_args['device_args'] ) ) {
942 826 if ( ! empty( $control_args['device_args'][ $device_name ] ) ) {
943 827 $control_args = array_merge( $control_args, $control_args['device_args'][ $device_name ] );
944 828 }
@@ -946,21 +830,15 @@
946 830 unset( $control_args['device_args'] );
947 831 }
948 832
949 833 if ( ! empty( $args['prefix_class'] ) ) {
950 - $device_to_replace = Breakpoints_Manager::BREAKPOINT_KEY_DESKTOP === $device_name ? '' : '-' . $device_name;
834 + $device_to_replace = self::RESPONSIVE_DESKTOP === $device_name ? '' : '-' . $device_name;
951 835
952 836 $control_args['prefix_class'] = sprintf( $args['prefix_class'], $device_to_replace );
953 837 }
954 838
955 - $direction = 'max';
839 + $control_args['responsive']['max'] = $device_name;
956 840
957 - if ( Breakpoints_Manager::BREAKPOINT_KEY_DESKTOP !== $device_name ) {
958 - $direction = $active_breakpoints[ $device_name ]->get_direction();
959 - }
960 -
961 - $control_args['responsive'][ $direction ] = $device_name;
962 -
963 841 if ( isset( $control_args['min_affected_device'] ) ) {
964 842 if ( ! empty( $control_args['min_affected_device'][ $device_name ] ) ) {
965 843 $control_args['responsive']['min'] = $control_args['min_affected_device'][ $device_name ];
966 844 }
@@ -971,26 +849,20 @@
971 849 if ( isset( $control_args[ $device_name . '_default' ] ) ) {
972 850 $control_args['default'] = $control_args[ $device_name . '_default' ];
973 851 }
974 852
975 - foreach ( $devices as $device ) {
976 - unset( $control_args[ $device . '_default' ] );
977 - }
853 + unset( $control_args['desktop_default'] );
854 + unset( $control_args['tablet_default'] );
855 + unset( $control_args['mobile_default'] );
978 856
979 - $id_suffix = Breakpoints_Manager::BREAKPOINT_KEY_DESKTOP === $device_name ? '' : '_' . $device_name;
980 - $control_name = $id . $id_suffix;
857 + $id_suffix = self::RESPONSIVE_DESKTOP === $device_name ? '' : '_' . $device_name;
981 858
982 - // Set this control as child of previous iteration control.
983 - if ( ! empty( $control_args['parent'] ) ) {
984 - $this->update_control( $control_args['parent'], [ 'inheritors' => [ $control_name ] ] );
985 - }
986 -
987 859 if ( ! empty( $options['overwrite'] ) ) {
988 - $this->update_control( $control_name, $control_args, [
860 + $this->update_control( $id . $id_suffix, $control_args, [
989 861 'recursive' => ! empty( $options['recursive'] ),
990 862 ] );
991 863 } else {
992 - $this->add_control( $control_name, $control_args, $options );
864 + $this->add_control( $id . $id_suffix, $control_args, $options );
993 865 }
994 866 }
995 867 }
996 868
@@ -1025,12 +897,16 @@
1025 897 *
1026 898 * @param string $id Responsive control ID.
1027 899 */
1028 900 final public function remove_responsive_control( $id ) {
1029 - $devices = Plugin::$instance->breakpoints->get_active_devices_list( [ 'reverse' => true ] );
901 + $devices = [
902 + self::RESPONSIVE_DESKTOP,
903 + self::RESPONSIVE_TABLET,
904 + self::RESPONSIVE_MOBILE,
905 + ];
1030 906
1031 907 foreach ( $devices as $device_name ) {
1032 - $id_suffix = Breakpoints_Manager::BREAKPOINT_KEY_DESKTOP === $device_name ? '' : '_' . $device_name;
908 + $id_suffix = self::RESPONSIVE_DESKTOP === $device_name ? '' : '_' . $device_name;
1033 909
1034 910 $this->remove_control( $id . $id_suffix );
1035 911 }
1036 912 }
@@ -1060,25 +936,15 @@
1060 936 * @return array|null The config.
1061 937 */
1062 938 final public function get_config() {
1063 939 if ( null === $this->config ) {
1064 - // TODO: This is for backwards compatibility starting from 2.9.0.
1065 - // This if statement should be removed when the method is hard-deprecated.
1066 - if ( $this->has_own_method( '_get_initial_config', self::class ) ) {
1067 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( '_get_initial_config', '2.9.0', __CLASS__ . '::get_initial_config()' );
1068 -
940 + // TODO: This is for backwards compatibility starting from 2.9.0
941 + // This if statement should be removed when the method is hard-deprecated
942 + if ( method_exists( $this, '_get_initial_config' ) ) {
1069 943 $this->config = $this->_get_initial_config();
1070 944 } else {
1071 945 $this->config = $this->get_initial_config();
1072 946 }
1073 -
1074 - foreach ( $this->additional_config as $key => $value ) {
1075 - if ( isset( $this->config[ $key ] ) ) {
1076 - $this->config[ $key ] = wp_parse_args( $value, $this->config[ $key ] );
1077 - } else {
1078 - $this->config[ $key ] = $value;
1079 - }
1080 - }
1081 947 }
1082 948
1083 949 return $this->config;
1084 950 }
@@ -1083,26 +949,8 @@
1083 949 return $this->config;
1084 950 }
1085 951
1086 952 /**
1087 - * Set a config property.
1088 - *
1089 - * Set a specific property of the config list for this controls-stack.
1090 - *
1091 - * @param string $key
1092 - * @param string $value
1093 - * @since 3.5.0
1094 - * @access public
1095 - */
1096 - public function set_config( $key, $value ) {
1097 - if ( isset( $this->additional_config[ $key ] ) ) {
1098 - $this->additional_config[ $key ] = wp_parse_args( $value, $this->additional_config[ $key ] );
1099 - } else {
1100 - $this->additional_config[ $key ] = $value;
1101 - }
1102 - }
1103 -
1104 - /**
1105 953 * Get frontend settings keys.
1106 954 *
1107 955 * Retrieve settings keys for all frontend controls.
1108 956 *
@@ -1166,11 +1014,8 @@
1166 1014 return self::get_items( $this->data, $item );
1167 1015 }
1168 1016
1169 1017 /**
1170 - * @param null $setting
1171 - * @param null $settings
1172 - * @return array|mixed|null
1173 1018 * @since 2.0.14
1174 1019 * @access public
1175 1020 */
1176 1021 public function get_parsed_dynamic_settings( $setting = null, $settings = null ) {
@@ -1189,16 +1034,16 @@
1189 1034 * Get active settings.
1190 1035 *
1191 1036 * Retrieve the settings from all the active controls.
1192 1037 *
1193 - * @param array|null $settings Optional. Controls settings. Default is null.
1194 - * @param array|null $controls Optional. An array of controls. Default is null.
1195 - *
1196 - * @return array Active settings.
1038 + * @since 1.4.0
1197 1039 * @since 2.1.0 Added the `controls` and the `settings` parameters.
1198 1040 * @access public
1199 1041 *
1200 - * @since 1.4.0
1042 + * @param array $controls Optional. An array of controls. Default is null.
1043 + * @param array $settings Optional. Controls settings. Default is null.
1044 + *
1045 + * @return array Active settings.
1201 1046 */
1202 1047 public function get_active_settings( $settings = null, $controls = null ) {
1203 1048 $is_first_request = ! $settings && ! $this->active_settings;
1204 1049
@@ -1213,10 +1058,8 @@
1213 1058 }
1214 1059
1215 1060 $active_settings = [];
1216 1061
1217 - $controls_objs = Plugin::$instance->controls_manager->get_controls();
1218 -
1219 1062 foreach ( $settings as $setting_key => $setting ) {
1220 1063 if ( ! isset( $controls[ $setting_key ] ) ) {
1221 1064 $active_settings[ $setting_key ] = $setting;
1222 1065
@@ -1224,10 +1067,10 @@
1224 1067 }
1225 1068
1226 1069 $control = $controls[ $setting_key ];
1227 1070
1228 - if ( $this->is_control_visible( $control, $settings, $controls ) ) {
1229 - $control_obj = $controls_objs[ $control['type'] ] ?? null;
1071 + if ( $this->is_control_visible( $control, $settings ) ) {
1072 + $control_obj = Plugin::$instance->controls_manager->get_control( $control['type'] );
1230 1073
1231 1074 if ( $control_obj instanceof Control_Repeater ) {
1232 1075 foreach ( $setting as & $item ) {
1233 1076 $item = $this->get_active_settings( $item, $control['fields'] );
@@ -1294,13 +1137,11 @@
1294 1137 if ( null === $controls ) {
1295 1138 $controls = $this->get_controls();
1296 1139 }
1297 1140
1298 - $controls_objs = Plugin::$instance->controls_manager->get_controls();
1299 -
1300 1141 foreach ( $controls as $control ) {
1301 1142 $control_name = $control['name'];
1302 - $control_obj = $controls_objs[ $control['type'] ] ?? null;
1143 + $control_obj = Plugin::$instance->controls_manager->get_control( $control['type'] );
1303 1144
1304 1145 if ( ! $control_obj instanceof Base_Data_Control ) {
1305 1146 continue;
1306 1147 }
@@ -1410,33 +1251,21 @@
1410 1251 );
1411 1252 }
1412 1253
1413 1254 /**
1414 - * Get Responsive Control Device Suffix
1415 - *
1416 - * @deprecated 3.7.6 Use `Elementor\Controls_Manager::get_responsive_control_device_suffix()` instead.
1417 - * @param array $control
1418 - * @return string $device suffix
1419 - */
1420 - protected function get_responsive_control_device_suffix( $control ) {
1421 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '3.7.6', 'Elementor\Controls_Manager::get_responsive_control_device_suffix()' );
1422 -
1423 - return Controls_Manager::get_responsive_control_device_suffix( $control );
1424 - }
1425 -
1426 - /**
1427 1255 * Whether the control is visible or not.
1428 1256 *
1429 1257 * Used to determine whether the control is visible or not.
1430 1258 *
1259 + * @since 1.4.0
1260 + * @access public
1261 + *
1431 1262 * @param array $control The control.
1432 - * @param null $values Optional. Condition values. Default is null.
1433 - * @param null $controls
1263 + * @param array $values Optional. Condition values. Default is null.
1264 + *
1434 1265 * @return bool Whether the control is visible.
1435 - * @since 1.4.0
1436 - * @access public
1437 1266 */
1438 - public function is_control_visible( $control, $values = null, $controls = null ) {
1267 + public function is_control_visible( $control, $values = null ) {
1439 1268 if ( null === $values ) {
1440 1269 $values = $this->get_settings();
1441 1270 }
1442 1271
@@ -1447,37 +1276,21 @@
1447 1276 if ( empty( $control['condition'] ) ) {
1448 1277 return true;
1449 1278 }
1450 1279
1451 - if ( ! $controls ) {
1452 - $controls = $this->get_controls();
1453 - }
1454 -
1455 1280 foreach ( $control['condition'] as $condition_key => $condition_value ) {
1456 1281 preg_match( '/([a-z_\-0-9]+)(?:\[([a-z_]+)])?(!?)$/i', $condition_key, $condition_key_parts );
1457 1282
1458 1283 $pure_condition_key = $condition_key_parts[1];
1459 1284 $condition_sub_key = $condition_key_parts[2];
1460 - $is_negative_condition = (bool) $condition_key_parts[3];
1285 + $is_negative_condition = ! ! $condition_key_parts[3];
1461 1286
1462 1287 if ( ! isset( $values[ $pure_condition_key ] ) || null === $values[ $pure_condition_key ] ) {
1463 1288 return false;
1464 1289 }
1465 1290
1466 - $are_control_and_condition_responsive = isset( $control['responsive'] ) && ! empty( $controls[ $pure_condition_key ]['responsive'] );
1467 - $condition_name_to_check = $pure_condition_key;
1291 + $instance_value = $values[ $pure_condition_key ];
1468 1292
1469 - if ( $are_control_and_condition_responsive ) {
1470 - $device_suffix = Controls_Manager::get_responsive_control_device_suffix( $control );
1471 -
1472 - $condition_name_to_check = $pure_condition_key . $device_suffix;
1473 -
1474 - // If the control is not desktop, and a conditioning control for the corresponding device exists, use it.
1475 - $instance_value = $values[ $pure_condition_key . $device_suffix ] ?? $values[ $pure_condition_key ];
1476 - } else {
1477 - $instance_value = $values[ $pure_condition_key ];
1478 - }
1479 -
1480 1293 if ( $condition_sub_key && is_array( $instance_value ) ) {
1481 1294 if ( ! isset( $instance_value[ $condition_sub_key ] ) ) {
1482 1295 return false;
1483 1296 }
@@ -1484,32 +1297,8 @@
1484 1297
1485 1298 $instance_value = $instance_value[ $condition_sub_key ];
1486 1299 }
1487 1300
1488 - if ( ! $instance_value ) {
1489 - $parent = isset( $controls[ $condition_name_to_check ]['parent'] ) ? $controls[ $condition_name_to_check ]['parent'] : false;
1490 -
1491 - while ( $parent ) {
1492 - $instance_value = $values[ $parent ];
1493 -
1494 - if ( $instance_value ) {
1495 - if ( ! is_array( $instance_value ) ) {
1496 - break;
1497 - }
1498 -
1499 - if ( $condition_sub_key && isset( $instance_value[ $condition_sub_key ] ) ) {
1500 - $instance_value = $instance_value[ $condition_sub_key ];
1501 -
1502 - if ( '' !== $instance_value ) {
1503 - break;
1504 - }
1505 - }
1506 - }
1507 -
1508 - $parent = isset( $controls[ $parent ]['parent'] ) ? $controls[ $parent ]['parent'] : false;
1509 - }
1510 - }
1511 -
1512 1301 /**
1513 1302 * If the $condition_value is a non empty array - check if the $condition_value contains the $instance_value,
1514 1303 * If the $instance_value is a non empty array - check if the $instance_value contains the $condition_value
1515 1304 * otherwise check if they are equal. ( and give the ability to check if the value is an empty array )
@@ -1521,12 +1310,9 @@
1521 1310 } else {
1522 1311 $is_contains = $instance_value === $condition_value;
1523 1312 }
1524 1313
1525 - if (
1526 - ( $is_negative_condition && $is_contains ) ||
1527 - ( ! $is_negative_condition && ! $is_contains )
1528 - ) {
1314 + if ( $is_negative_condition && $is_contains || ! $is_negative_condition && ! $is_contains ) {
1529 1315 return false;
1530 1316 }
1531 1317 }
1532 1318
@@ -1539,9 +1325,9 @@
1539 1325 * Used to add a new section of controls. When you use this method, all the
1540 1326 * registered controls from this point will be assigned to this section,
1541 1327 * until you close the section using `end_controls_section()` method.
1542 1328 *
1543 - * This method should be used inside `register_controls()`.
1329 + * This method should be used inside `_register_controls()`.
1544 1330 *
1545 1331 * @since 1.4.0
1546 1332 * @access public
1547 1333 *
@@ -1548,9 +1334,9 @@
1548 1334 * @param string $section_id Section ID.
1549 1335 * @param array $args Section arguments Optional.
1550 1336 */
1551 1337 public function start_controls_section( $section_id, array $args = [] ) {
1552 - $stack_name = $this->get_name();
1338 + $section_name = $this->get_name();
1553 1339
1554 1340 /**
1555 1341 * Before section start.
1556 1342 *
@@ -1568,9 +1354,9 @@
1568 1354 * Before section start.
1569 1355 *
1570 1356 * Fires before Elementor section starts in the editor panel.
1571 1357 *
1572 - * The dynamic portions of the hook name, `$stack_name` and `$section_id`, refers to the stack name and section ID, respectively.
1358 + * The dynamic portions of the hook name, `$section_name` and `$section_id`, refers to the section name and section ID, respectively.
1573 1359 *
1574 1360 * @since 1.4.0
1575 1361 *
1576 1362 * @param Controls_Stack $this The control.
@@ -1575,20 +1361,16 @@
1575 1361 *
1576 1362 * @param Controls_Stack $this The control.
1577 1363 * @param array $args Section arguments.
1578 1364 */
1579 - do_action( "elementor/element/{$stack_name}/{$section_id}/before_section_start", $this, $args );
1365 + do_action( "elementor/element/{$section_name}/{$section_id}/before_section_start", $this, $args );
1580 1366
1581 - if ( $this->should_manually_trigger_common_action( $stack_name ) ) {
1582 - do_action( "elementor/element/common/{$section_id}/before_section_start", $this, $args );
1583 - }
1584 -
1585 1367 $args['type'] = Controls_Manager::SECTION;
1586 1368
1587 1369 $this->add_control( $section_id, $args );
1588 1370
1589 1371 if ( null !== $this->current_section ) {
1590 - wp_die( sprintf( 'Elementor: You can\'t start a section before the end of the previous section "%s".', $this->current_section['section'] ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1372 + wp_die( sprintf( 'Elementor: You can\'t start a section before the end of the previous section "%s".', $this->current_section['section'] ) ); // XSS ok.
1591 1373 }
1592 1374
1593 1375 $this->current_section = $this->get_section_args( $section_id );
1594 1376
@@ -1613,9 +1395,9 @@
1613 1395 * After section start.
1614 1396 *
1615 1397 * Fires after Elementor section starts in the editor panel.
1616 1398 *
1617 - * The dynamic portions of the hook name, `$stack_name` and `$section_id`, refers to the stack name and section ID, respectively.
1399 + * The dynamic portions of the hook name, `$section_name` and `$section_id`, refers to the section name and section ID, respectively.
1618 1400 *
1619 1401 * @since 1.4.0
1620 1402 *
1621 1403 * @param Controls_Stack $this The control.
@@ -1620,13 +1402,9 @@
1620 1402 *
1621 1403 * @param Controls_Stack $this The control.
1622 1404 * @param array $args Section arguments.
1623 1405 */
1624 - do_action( "elementor/element/{$stack_name}/{$section_id}/after_section_start", $this, $args );
1625 -
1626 - if ( $this->should_manually_trigger_common_action( $stack_name ) ) {
1627 - do_action( "elementor/element/common/{$section_id}/after_section_start", $this, $args );
1628 - }
1406 + do_action( "elementor/element/{$section_name}/{$section_id}/after_section_start", $this, $args );
1629 1407 }
1630 1408
1631 1409 /**
1632 1410 * End controls section.
@@ -1633,9 +1411,9 @@
1633 1411 *
1634 1412 * Used to close an existing open controls section. When you use this method
1635 1413 * it stops adding new controls to this section.
1636 1414 *
1637 - * This method should be used inside `register_controls()`.
1415 + * This method should be used inside `_register_controls()`.
1638 1416 *
1639 1417 * @since 1.4.0
1640 1418 * @access public
1641 1419 */
@@ -1675,12 +1453,8 @@
1675 1453 * @param array $args Section arguments.
1676 1454 */
1677 1455 do_action( "elementor/element/{$stack_name}/{$section_id}/before_section_end", $this, $args );
1678 1456
1679 - if ( $this->should_manually_trigger_common_action( $stack_name ) ) {
1680 - do_action( "elementor/element/common/{$section_id}/before_section_end", $this, $args );
1681 - }
1682 -
1683 1457 $this->current_section = null;
1684 1458
1685 1459 /**
1686 1460 * After section end.
@@ -1699,9 +1473,9 @@
1699 1473 * After section end.
1700 1474 *
1701 1475 * Fires after Elementor section ends in the editor panel.
1702 1476 *
1703 - * The dynamic portions of the hook name, `$stack_name` and `$section_id`, refers to the stack name and section ID, respectively.
1477 + * The dynamic portions of the hook name, `$stack_name` and `$section_id`, refers to the section name and section ID, respectively.
1704 1478 *
1705 1479 * @since 1.4.0
1706 1480 *
1707 1481 * @param Controls_Stack $this The control.
@@ -1707,40 +1481,11 @@
1707 1481 * @param Controls_Stack $this The control.
1708 1482 * @param array $args Section arguments.
1709 1483 */
1710 1484 do_action( "elementor/element/{$stack_name}/{$section_id}/after_section_end", $this, $args );
1711 -
1712 - if ( $this->should_manually_trigger_common_action( $stack_name ) ) {
1713 - do_action( "elementor/element/common/{$section_id}/after_section_end", $this, $args );
1714 - }
1715 1485 }
1716 1486
1717 1487 /**
1718 - * Should manually trigger common action.
1719 - *
1720 - * With the Optimized Markup experiment, the Advanced Tab has been split to maintain backward compatibility:
1721 - * - 'common' refers to the existing Advanced Tab.
1722 - * - 'common-optimized' refers to the new Advanced Tab for optimized widgets.
1723 - *
1724 - * Third-party developers may have used hooks like 'elementor/element/common/_section_background/before_section_end'
1725 - * to add controls to the Advanced Tab. However, this hook will now only work on widgets that are not optimized.
1726 - *
1727 - * This method checks whether the 'elementor/element/common/...' hooks should be manually executed
1728 - * to prevent third parties from needing to add equivalent hooks for 'elementor/element/common-optimized/...'.
1729 - *
1730 - * @todo Remove this method and the manual execution of 'common' hooks when the feature is merged.
1731 - *
1732 - * @access private
1733 - *
1734 - * @param string $stack_name Stack name.
1735 - *
1736 - * @return bool
1737 - */
1738 - private function should_manually_trigger_common_action( $stack_name ): bool {
1739 - return 'common-optimized' === $stack_name && Plugin::$instance->experiments->is_feature_active( 'e_optimized_markup' );
1740 - }
1741 -
1742 - /**
1743 1488 * Start controls tabs.
1744 1489 *
1745 1490 * Used to add a new set of tabs inside a section. You should use this
1746 1491 * method before adding new individual tabs using `start_controls_tab()`.
@@ -1746,9 +1491,9 @@
1746 1491 * method before adding new individual tabs using `start_controls_tab()`.
1747 1492 * Each tab added after this point will be assigned to this group of tabs,
1748 1493 * until you close it using `end_controls_tabs()` method.
1749 1494 *
1750 - * This method should be used inside `register_controls()`.
1495 + * This method should be used inside `_register_controls()`.
1751 1496 *
1752 1497 * @since 1.4.0
1753 1498 * @access public
1754 1499 *
@@ -1756,9 +1501,9 @@
1756 1501 * @param array $args Tabs arguments.
1757 1502 */
1758 1503 public function start_controls_tabs( $tabs_id, array $args = [] ) {
1759 1504 if ( null !== $this->current_tab ) {
1760 - wp_die( sprintf( 'Elementor: You can\'t start tabs before the end of the previous tabs "%s".', $this->current_tab['tabs_wrapper'] ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1505 + wp_die( sprintf( 'Elementor: You can\'t start tabs before the end of the previous tabs "%s".', $this->current_tab['tabs_wrapper'] ) ); // XSS ok.
1761 1506 }
1762 1507
1763 1508 $args['type'] = Controls_Manager::TABS;
1764 1509
@@ -1784,9 +1529,9 @@
1784 1529 *
1785 1530 * Used to close an existing open controls tabs. When you use this method it
1786 1531 * stops adding new controls to this tabs.
1787 1532 *
1788 - * This method should be used inside `register_controls()`.
1533 + * This method should be used inside `_register_controls()`.
1789 1534 *
1790 1535 * @since 1.4.0
1791 1536 * @access public
1792 1537 */
@@ -1801,9 +1546,9 @@
1801 1546 * adding new individual tabs using `start_controls_tab()`.
1802 1547 * Each tab added after this point will be assigned to this group of tabs,
1803 1548 * until you close it using `end_controls_tab()` method.
1804 1549 *
1805 - * This method should be used inside `register_controls()`.
1550 + * This method should be used inside `_register_controls()`.
1806 1551 *
1807 1552 * @since 1.4.0
1808 1553 * @access public
1809 1554 *
@@ -1811,9 +1556,9 @@
1811 1556 * @param array $args Tab arguments.
1812 1557 */
1813 1558 public function start_controls_tab( $tab_id, $args ) {
1814 1559 if ( ! empty( $this->current_tab['inner_tab'] ) ) {
1815 - wp_die( sprintf( 'Elementor: You can\'t start a tab before the end of the previous tab "%s".', $this->current_tab['inner_tab'] ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1560 + wp_die( sprintf( 'Elementor: You can\'t start a tab before the end of the previous tab "%s".', $this->current_tab['inner_tab'] ) ); // XSS ok.
1816 1561 }
1817 1562
1818 1563 $args['type'] = Controls_Manager::TAB;
1819 1564 $args['tabs_wrapper'] = $this->current_tab['tabs_wrapper'];
@@ -1832,9 +1577,9 @@
1832 1577 *
1833 1578 * Used to close an existing open controls tab. When you use this method it
1834 1579 * stops adding new controls to this tab.
1835 1580 *
1836 - * This method should be used inside `register_controls()`.
1581 + * This method should be used inside `_register_controls()`.
1837 1582 *
1838 1583 * @since 1.4.0
1839 1584 * @access public
1840 1585 */
@@ -1848,9 +1593,9 @@
1848 1593 * Used to add a new set of controls in a popover. When you use this method,
1849 1594 * all the registered controls from this point will be assigned to this
1850 1595 * popover, until you close the popover using `end_popover()` method.
1851 1596 *
1852 - * This method should be used inside `register_controls()`.
1597 + * This method should be used inside `_register_controls()`.
1853 1598 *
1854 1599 * @since 1.9.0
1855 1600 * @access public
1856 1601 */
@@ -1865,9 +1610,9 @@
1865 1610 *
1866 1611 * Used to close an existing open popover. When you use this method it stops
1867 1612 * adding new controls to this popover.
1868 1613 *
1869 - * This method should be used inside `register_controls()`.
1614 + * This method should be used inside `_register_controls()`.
1870 1615 *
1871 1616 * @since 1.9.0
1872 1617 * @access public
1873 1618 */
@@ -1889,196 +1634,8 @@
1889 1634 $this->update_control( $last_control_key, $args, $options );
1890 1635 }
1891 1636
1892 1637 /**
1893 - * Add render attribute.
1894 - *
1895 - * Used to add attributes to a specific HTML element.
1896 - *
1897 - * The HTML tag is represented by the element parameter, then you need to
1898 - * define the attribute key and the attribute key. The final result will be:
1899 - * `<element attribute_key="attribute_value">`.
1900 - *
1901 - * Example usage:
1902 - *
1903 - * `$this->add_render_attribute( 'wrapper', 'class', 'custom-widget-wrapper-class' );`
1904 - * `$this->add_render_attribute( 'widget', 'id', 'custom-widget-id' );`
1905 - * `$this->add_render_attribute( 'button', [ 'class' => 'custom-button-class', 'id' => 'custom-button-id' ] );`
1906 - *
1907 - * @since 1.0.0
1908 - * @access public
1909 - *
1910 - * @param array|string $element The HTML element.
1911 - * @param array|string $key Optional. Attribute key. Default is null.
1912 - * @param array|string $value Optional. Attribute value. Default is null.
1913 - * @param bool $overwrite Optional. Whether to overwrite existing
1914 - * attribute. Default is false, not to overwrite.
1915 - *
1916 - * @return self Current instance of the element.
1917 - */
1918 - public function add_render_attribute( $element, $key = null, $value = null, $overwrite = false ) {
1919 - if ( is_array( $element ) ) {
1920 - foreach ( $element as $element_key => $attributes ) {
1921 - $this->add_render_attribute( $element_key, $attributes, null, $overwrite );
1922 - }
1923 -
1924 - return $this;
1925 - }
1926 -
1927 - if ( is_array( $key ) ) {
1928 - foreach ( $key as $attribute_key => $attributes ) {
1929 - $this->add_render_attribute( $element, $attribute_key, $attributes, $overwrite );
1930 - }
1931 -
1932 - return $this;
1933 - }
1934 -
1935 - if ( empty( $this->render_attributes[ $element ][ $key ] ) ) {
1936 - $this->render_attributes[ $element ][ $key ] = [];
1937 - }
1938 -
1939 - settype( $value, 'array' );
1940 -
1941 - if ( $overwrite ) {
1942 - $this->render_attributes[ $element ][ $key ] = $value;
1943 - } else {
1944 - $this->render_attributes[ $element ][ $key ] = array_merge( $this->render_attributes[ $element ][ $key ], $value );
1945 - }
1946 -
1947 - return $this;
1948 - }
1949 -
1950 - /**
1951 - * Get Render Attributes
1952 - *
1953 - * Used to retrieve render attribute.
1954 - *
1955 - * The returned array is either all elements and their attributes if no `$element` is specified, an array of all
1956 - * attributes of a specific element or a specific attribute properties if `$key` is specified.
1957 - *
1958 - * Returns null if one of the requested parameters isn't set.
1959 - *
1960 - * @since 2.2.6
1961 - * @access public
1962 - * @param string $element
1963 - * @param string $key
1964 - *
1965 - * @return array
1966 - */
1967 - public function get_render_attributes( $element = '', $key = '' ) {
1968 - $attributes = $this->render_attributes;
1969 -
1970 - if ( $element ) {
1971 - if ( ! isset( $attributes[ $element ] ) ) {
1972 - return null;
1973 - }
1974 -
1975 - $attributes = $attributes[ $element ];
1976 -
1977 - if ( $key ) {
1978 - if ( ! isset( $attributes[ $key ] ) ) {
1979 - return null;
1980 - }
1981 -
1982 - $attributes = $attributes[ $key ];
1983 - }
1984 - }
1985 -
1986 - return $attributes;
1987 - }
1988 -
1989 - /**
1990 - * Set render attribute.
1991 - *
1992 - * Used to set the value of the HTML element render attribute or to update
1993 - * an existing render attribute.
1994 - *
1995 - * @since 1.0.0
1996 - * @access public
1997 - *
1998 - * @param array|string $element The HTML element.
1999 - * @param array|string $key Optional. Attribute key. Default is null.
2000 - * @param array|string $value Optional. Attribute value. Default is null.
2001 - *
2002 - * @return self Current instance of the element.
2003 - */
2004 - public function set_render_attribute( $element, $key = null, $value = null ) {
2005 - return $this->add_render_attribute( $element, $key, $value, true );
2006 - }
2007 -
2008 - /**
2009 - * Remove render attribute.
2010 - *
2011 - * Used to remove an element (with its keys and their values), key (with its values),
2012 - * or value/s from an HTML element's render attribute.
2013 - *
2014 - * @since 2.7.0
2015 - * @access public
2016 - *
2017 - * @param string $element The HTML element.
2018 - * @param string $key Optional. Attribute key. Default is null.
2019 - * @param array|string $values Optional. Attribute value/s. Default is null.
2020 - */
2021 - public function remove_render_attribute( $element, $key = null, $values = null ) {
2022 - if ( $key && ! isset( $this->render_attributes[ $element ][ $key ] ) ) {
2023 - return;
2024 - }
2025 -
2026 - if ( $values ) {
2027 - $values = (array) $values;
2028 -
2029 - $this->render_attributes[ $element ][ $key ] = array_diff( $this->render_attributes[ $element ][ $key ], $values );
2030 -
2031 - return;
2032 - }
2033 -
2034 - if ( $key ) {
2035 - unset( $this->render_attributes[ $element ][ $key ] );
2036 -
2037 - return;
2038 - }
2039 -
2040 - if ( isset( $this->render_attributes[ $element ] ) ) {
2041 - unset( $this->render_attributes[ $element ] );
2042 - }
2043 - }
2044 -
2045 - /**
2046 - * Get render attribute string.
2047 - *
2048 - * Used to retrieve the value of the render attribute.
2049 - *
2050 - * @since 1.0.0
2051 - * @access public
2052 - *
2053 - * @param string $element The element.
2054 - *
2055 - * @return string Render attribute string, or an empty string if the attribute
2056 - * is empty or not exist.
2057 - */
2058 - public function get_render_attribute_string( $element ) {
2059 - if ( empty( $this->render_attributes[ $element ] ) ) {
2060 - return '';
2061 - }
2062 -
2063 - return Utils::render_html_attributes( $this->render_attributes[ $element ] );
2064 - }
2065 -
2066 - /**
2067 - * Print render attribute string.
2068 - *
2069 - * Used to output the rendered attribute.
2070 - *
2071 - * @since 2.0.0
2072 - * @access public
2073 - *
2074 - * @param array|string $element The element.
2075 - */
2076 - public function print_render_attribute_string( $element ) {
2077 - Utils::print_unescaped_internal_string( $this->get_render_attribute_string( $element ) );
2078 - }
2079 -
2080 - /**
2081 1638 * Print element template.
2082 1639 *
2083 1640 * Used to generate the element template on the editor.
2084 1641 *
@@ -2088,12 +1645,10 @@
2088 1645 public function print_template() {
2089 1646 ob_start();
2090 1647
2091 1648 // TODO: This is for backwards compatibility starting from 2.9.0
2092 - // This `if` statement should be removed when the method is removed.
2093 - if ( $this->has_own_method( '_content_template', self::class ) ) {
2094 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( '_content_template', '2.9.0', __CLASS__ . '::content_template()' );
2095 -
1649 + // This `if` statement should be removed when the method is removed
1650 + if ( method_exists( $this, '_content_template' ) ) {
2096 1651 $this->_content_template();
2097 1652 } else {
2098 1653 $this->content_template();
2099 1654 }
@@ -2126,23 +1681,8 @@
2126 1681 <?php
2127 1682 }
2128 1683
2129 1684 /**
2130 - * On import update dynamic content (e.g. post and term IDs).
2131 - *
2132 - * @since 3.8.0
2133 - *
2134 - * @param array $config The config of the passed element.
2135 - * @param array $data The data that requires updating/replacement when imported.
2136 - * @param array|null $controls The available controls.
2137 - *
2138 - * @return array Element data.
2139 - */
2140 - public static function on_import_update_dynamic_content( array $config, array $data, $controls = null ): array {
2141 - return $config;
2142 - }
2143 -
2144 - /**
2145 1685 * Start injection.
2146 1686 *
2147 1687 * Used to inject controls and sections to a specific position in the stack.
2148 1688 *
@@ -2217,33 +1757,12 @@
2217 1757 * `start_controls_tab()`.
2218 1758 *
2219 1759 * @since 1.4.0
2220 1760 * @access protected
2221 - * @deprecated 3.1.0 Use `register_controls()` method instead.
2222 1761 */
2223 - protected function _register_controls() {
2224 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '3.1.0', 'register_controls()' );
1762 + protected function _register_controls() {}
2225 1763
2226 - $this->register_controls();
2227 - }
2228 -
2229 1764 /**
2230 - * Register controls.
2231 - *
2232 - * Used to add new controls to any element type. For example, external
2233 - * developers use this method to register controls in a widget.
2234 - *
2235 - * Should be inherited and register new controls using `add_control()`,
2236 - * `add_responsive_control()` and `add_group_control()`, inside control
2237 - * wrappers like `start_controls_section()`, `start_controls_tabs()` and
2238 - * `start_controls_tab()`.
2239 - *
2240 - * @since 3.1.0
2241 - * @access protected
2242 - */
2243 - protected function register_controls() {}
2244 -
2245 - /**
2246 1765 * Get default data.
2247 1766 *
2248 1767 * Retrieve the default data. Used to reset the data on initialization.
2249 1768 *
@@ -2265,12 +1784,10 @@
2265 1784 */
2266 1785 protected function get_init_settings() {
2267 1786 $settings = $this->get_data( 'settings' );
2268 1787
2269 - $controls_objs = Plugin::$instance->controls_manager->get_controls();
2270 -
2271 1788 foreach ( $this->get_controls() as $control ) {
2272 - $control_obj = $controls_objs[ $control['type'] ] ?? null;
1789 + $control_obj = Plugin::$instance->controls_manager->get_control( $control['type'] );
2273 1790
2274 1791 if ( ! $control_obj instanceof Base_Data_Control ) {
2275 1792 continue;
2276 1793 }
@@ -2306,15 +1823,15 @@
2306 1823 * Retrieve the current element initial configuration - controls list and
2307 1824 * the tabs assigned to the control.
2308 1825 *
2309 1826 * @since 1.4.0
2310 - * @deprecated 2.9.0 Use `get_initial_config()` method instead.
1827 + * @deprecated 2.9.0 use `get_initial_config()` instead
2311 1828 * @access protected
2312 1829 *
2313 1830 * @return array The initial config.
2314 1831 */
2315 1832 protected function _get_initial_config() {
2316 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '2.9.0', 'get_initial_config()' );
1833 + // _deprecated_function( __METHOD__, '2.9.0', 'get_initial_config' );
2317 1834
2318 1835 return $this->get_initial_config();
2319 1836 }
2320 1837
@@ -2352,30 +1869,8 @@
2352 1869 */
2353 1870 protected function render() {}
2354 1871
2355 1872 /**
2356 - * Render element in static mode.
2357 - *
2358 - * If not inherent will call the base render.
2359 - */
2360 - protected function render_static() {
2361 - $this->render();
2362 - }
2363 -
2364 - /**
2365 - * Determine the render logic.
2366 - */
2367 - protected function render_by_mode() {
2368 - if ( Plugin::$instance->frontend->is_static_render_mode() ) {
2369 - $this->render_static();
2370 -
2371 - return;
2372 - }
2373 -
2374 - $this->render();
2375 - }
2376 -
2377 - /**
2378 1873 * Print content template.
2379 1874 *
2380 1875 * Used to generate the content template on the editor, using a
2381 1876 * Backbone JavaScript template.
@@ -2385,9 +1880,9 @@
2385 1880 *
2386 1881 * @param string $template_content Template content.
2387 1882 */
2388 1883 protected function print_template_content( $template_content ) {
2389 - Utils::print_unescaped_internal_string( $template_content );
1884 + echo $template_content;
2390 1885 }
2391 1886
2392 1887 /**
2393 1888 * Render element output in the editor.
@@ -2404,13 +1899,13 @@
2404 1899 *
2405 1900 * Used to generate the live preview, using a Backbone JavaScript template.
2406 1901 *
2407 1902 * @since 2.0.0
2408 - * @deprecated 2.9.0 Use `content_template()` method instead.
1903 + * @deprecated 2.9.0 use `content_template()` instead
2409 1904 * @access protected
2410 1905 */
2411 1906 protected function _content_template() {
2412 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '2.9.0', 'content_template()' );
1907 + // _deprecated_function( __METHOD__, '2.9.0', 'content_template' );
2413 1908
2414 1909 $this->content_template();
2415 1910 }
2416 1911
@@ -2416,9 +1911,9 @@
2416 1911
2417 1912 /**
2418 1913 * Initialize controls.
2419 1914 *
2420 - * Register the all controls added by `register_controls()`.
1915 + * Register the all controls added by `_register_controls()`.
2421 1916 *
2422 1917 * @since 2.0.0
2423 1918 * @access protected
2424 1919 */
@@ -2425,12 +1920,10 @@
2425 1920 protected function init_controls() {
2426 1921 Plugin::$instance->controls_manager->open_stack( $this );
2427 1922
2428 1923 // TODO: This is for backwards compatibility starting from 2.9.0
2429 - // This `if` statement should be removed when the method is removed.
2430 - if ( $this->has_own_method( '_register_controls', self::class ) ) {
2431 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( '_register_controls', '3.1.0', __CLASS__ . '::register_controls()' );
2432 -
1924 + // This `if` statement should be removed when the method is removed
1925 + if ( method_exists( $this, '_register_controls' ) ) {
2433 1926 $this->_register_controls();
2434 1927 } else {
2435 1928 $this->register_controls();
2436 1929 }
@@ -2454,9 +1947,9 @@
2454 1947 }
2455 1948
2456 1949 if ( null !== $target_section_args ) {
2457 1950 if ( ! empty( $args['section'] ) || ! empty( $args['tab'] ) ) {
2458 - _doing_it_wrong( sprintf( '%s::%s', get_called_class(), __FUNCTION__ ), sprintf( 'Cannot redeclare control with `tab` or `section` args inside section "%s".', $control_id ), '1.0.0' ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1951 + _doing_it_wrong( sprintf( '%s::%s', get_called_class(), __FUNCTION__ ), sprintf( 'Cannot redeclare control with `tab` or `section` args inside section "%s".', $control_id ), '1.0.0' );
2459 1952 }
2460 1953
2461 1954 $args = array_replace_recursive( $target_section_args, $args );
2462 1955
@@ -2463,11 +1956,9 @@
2463 1956 if ( null !== $target_tab ) {
2464 1957 $args = array_replace_recursive( $target_tab, $args );
2465 1958 }
2466 1959 } elseif ( empty( $args['section'] ) && ( ! $overwrite || is_wp_error( Plugin::$instance->controls_manager->get_control_from_stack( $this->get_unique_name(), $control_id ) ) ) ) {
2467 - if ( ! Performance::should_optimize_controls() ) {
2468 - wp_die( sprintf( '%s::%s: Cannot add a control outside of a section (use `start_controls_section`).', get_called_class(), __FUNCTION__ ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
2469 - }
1960 + wp_die( sprintf( '%s::%s: Cannot add a control outside of a section (use `start_controls_section`).', get_called_class(), __FUNCTION__ ) );
2470 1961 }
2471 1962
2472 1963 return $args;
2473 1964 }
@@ -2493,15 +1984,15 @@
2493 1984 *
2494 1985 * Set the raw data, the ID and the parsed settings.
2495 1986 *
2496 1987 * @since 1.4.0
2497 - * @deprecated 2.9.0 Use `init()` method instead.
1988 + * @deprecated 2.9.0 use `init()` instead
2498 1989 * @access protected
2499 1990 *
2500 1991 * @param array $data Initial data.
2501 1992 */
2502 1993 protected function _init( $data ) {
2503 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '2.9.0', 'init()' );
1994 + // _deprecated_function( __METHOD__, '2.9.0', 'init' );
2504 1995
2505 1996 $this->init( $data );
2506 1997 }
2507 1998
@@ -2572,12 +2063,10 @@
2572 2063 */
2573 2064 public function __construct( array $data = [] ) {
2574 2065 if ( $data ) {
2575 2066 // TODO: This is for backwards compatibility starting from 2.9.0
2576 - // This if statement should be removed when the method is hard-deprecated.
2577 - if ( $this->has_own_method( '_init', self::class ) ) {
2578 - Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( '_init', '2.9.0', __CLASS__ . '::init()' );
2579 -
2067 + // This if statement should be removed when the method is hard-deprecated
2068 + if ( method_exists( $this, '_init' ) ) {
2580 2069 $this->_init( $data );
2581 2070 } else {
2582 2071 $this->init( $data );
2583 2072 }