PluginProbe
Elementor Website Builder – more than just a page builder / 3.14.0-beta4
Elementor Website Builder – more than just a page builder v3.14.0-beta4
4.3.4 4.3.3 4.3.2 4.3.1 4.3.0 4.3.0-beta3 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 All 457 releases
← All changes | core/experiments/manager.php +194 -411 4.3.4 → 3.14.0-beta4 View file →
@@ -1,9 +1,8 @@
1 1 <?php
2 2 namespace Elementor\Core\Experiments;
3 3
4 4 use Elementor\Core\Base\Base_Object;
5 -use Elementor\Core\Experiments\Exceptions\Dependency_Exception;
6 5 use Elementor\Core\Upgrade\Manager as Upgrade_Manager;
7 6 use Elementor\Core\Utils\Collection;
8 7 use Elementor\Modules\System_Info\Module as System_Info;
9 8 use Elementor\Plugin;
@@ -11,9 +10,9 @@
11 10 use Elementor\Tracker;
12 11 use Elementor\Utils;
13 12
14 13 if ( ! defined( 'ABSPATH' ) ) {
15 - exit; // Exit if accessed directly.
14 + exit; // Exit if accessed directly
16 15 }
17 16
18 17 class Manager extends Base_Object {
19 18
@@ -22,8 +21,10 @@
22 21 const RELEASE_STATUS_ALPHA = 'alpha';
23 22
24 23 const RELEASE_STATUS_BETA = 'beta';
25 24
25 + const RELEASE_STATUS_RC = 'rc';
26 +
26 27 const RELEASE_STATUS_STABLE = 'stable';
27 28
28 29 const STATE_DEFAULT = 'default';
29 30
@@ -32,10 +33,8 @@
32 33 const STATE_INACTIVE = 'inactive';
33 34
34 35 const TYPE_HIDDEN = 'hidden';
35 36
36 - const OPTION_PREFIX = 'elementor_experiment-';
37 -
38 37 private $states;
39 38
40 39 private $release_statuses;
41 40
@@ -43,26 +42,24 @@
43 42
44 43 /**
45 44 * Add Feature
46 45 *
47 - * Each feature has to provide the following information:
48 - * [
49 - * 'name' => string,
50 - * 'title' => string,
51 - * 'description' => string,
52 - * 'tag' => string,
53 - * 'release_status' => string,
54 - * 'default' => string,
55 - * 'new_site' => array,
56 - * ]
57 - *
58 46 * @since 3.1.0
59 47 * @access public
60 48 *
61 - * @param array $options Feature options.
49 + * @param array $options {
50 + * @type string $name
51 + * @type string $title
52 + * @type string $tag
53 + * @type array $tags
54 + * @type string $description
55 + * @type string $release_status
56 + * @type string $default
57 + * @type callable $on_state_change
58 + * }
59 + *
62 60 * @return array|null
63 - *
64 - * @throws Dependency_Exception If can't change feature state.
61 + * @throws \Exception
65 62 */
66 63 public function add_feature( array $options ) {
67 64 if ( isset( $this->features[ $options['name'] ] ) ) {
68 65 return null;
@@ -67,14 +64,45 @@
67 64 if ( isset( $this->features[ $options['name'] ] ) ) {
68 65 return null;
69 66 }
70 67
71 - $experimental_data = $this->set_feature_initial_options( $options );
68 + $default_experimental_data = [
69 + 'tag' => '', // Deprecated, use 'tags' instead.
70 + 'tags' => [],
71 + 'description' => '',
72 + 'release_status' => self::RELEASE_STATUS_ALPHA,
73 + 'default' => self::STATE_INACTIVE,
74 + 'mutable' => true,
75 + static::TYPE_HIDDEN => false,
76 + 'new_site' => [
77 + 'default_active' => false,
78 + 'always_active' => false,
79 + 'minimum_installation_version' => null,
80 + ],
81 + 'on_state_change' => null,
82 + 'generator_tag' => false,
83 + ];
72 84
85 + $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages' ];
86 +
87 + $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
88 +
89 + $experimental_data = $this->unify_feature_tags( $experimental_data );
90 +
73 91 $new_site = $experimental_data['new_site'];
74 92
75 - if ( $new_site['default_active'] || $new_site['always_active'] || $new_site['default_inactive'] ) {
76 - $experimental_data = $this->set_new_site_default_state( $new_site, $experimental_data );
93 + if ( $new_site['default_active'] || $new_site['always_active'] ) {
94 + $is_new_installation = Upgrade_Manager::install_compare( $new_site['minimum_installation_version'], '>=' );
95 +
96 + if ( $is_new_installation ) {
97 + if ( $new_site['always_active'] ) {
98 + $experimental_data['state'] = self::STATE_ACTIVE;
99 +
100 + $experimental_data['mutable'] = false;
101 + } elseif ( $new_site['default_active'] ) {
102 + $experimental_data['default'] = self::STATE_ACTIVE;
103 + }
104 + }
77 105 }
78 106
79 107 if ( $experimental_data['mutable'] ) {
80 108 $experimental_data['state'] = $this->get_saved_feature_state( $options['name'] );
@@ -84,15 +112,21 @@
84 112 $experimental_data['state'] = self::STATE_DEFAULT;
85 113 }
86 114
87 115 if ( ! empty( $experimental_data['dependencies'] ) ) {
88 - $experimental_data = $this->initialize_feature_dependencies( $experimental_data );
116 + foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
117 + $feature = $this->get_features( $dependency );
118 +
119 + if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
120 + throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
121 + }
122 +
123 + $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
124 + }
89 125 }
90 126
91 127 $this->features[ $options['name'] ] = $experimental_data;
92 128
93 - $this->resolve_registered_dependants( $options['name'], $experimental_data );
94 -
95 129 if ( $experimental_data['mutable'] && is_admin() ) {
96 130 $feature_option_key = $this->get_feature_option_key( $options['name'] );
97 131
98 132 $on_state_change_callback = function( $old_state, $new_state ) use ( $experimental_data, $feature_option_key ) {
@@ -101,9 +135,9 @@
101 135 } catch ( Exceptions\Dependency_Exception $e ) {
102 136 $message = sprintf(
103 137 '<p>%s</p><p><a href="#" onclick="location.href=\'%s\'">%s</a></p>',
104 138 esc_html( $e->getMessage() ),
105 - Settings::get_settings_tab_url( 'experiments' ),
139 + site_url( 'wp-admin/admin.php?page=elementor#tab-experiments' ),
106 140 esc_html__( 'Back', 'elementor' )
107 141 );
108 142
109 143 wp_die( $message ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
@@ -118,26 +152,8 @@
118 152
119 153 return $experimental_data;
120 154 }
121 155
122 - private function install_compare( $version ) {
123 - $installs_history = Upgrade_Manager::get_installs_history();
124 -
125 - if ( empty( $installs_history ) ) {
126 - // Fresh installation: upgrade manager hasn't written history yet on this first request.
127 - // Use the current plugin version as the effective first-install version.
128 - return version_compare( ELEMENTOR_VERSION, $version, '>=' );
129 - }
130 -
131 - $cleaned_version = preg_replace( '/-(beta|cloud|dev)\d*$/', '', key( $installs_history ) );
132 -
133 - return version_compare(
134 - $cleaned_version,
135 - $version,
136 - '>='
137 - );
138 - }
139 -
140 156 /**
141 157 * Combine 'tag' and 'tags' into one property.
142 158 *
143 159 * @param array $experimental_data
@@ -143,9 +159,9 @@
143 159 * @param array $experimental_data
144 160 *
145 161 * @return array
146 162 */
147 - private function unify_feature_tags( array $experimental_data ): array {
163 + private function unify_feature_tags( array $experimental_data ) : array {
148 164 foreach ( [ 'tag', 'tags' ] as $key ) {
149 165 if ( empty( $experimental_data[ $key ] ) ) {
150 166 continue;
151 167 }
@@ -162,21 +178,18 @@
162 178
163 179 /**
164 180 * Format feature tags into the right format.
165 181 *
166 - * If an array of tags provided, each tag has to provide the following information:
167 - * [
168 - * [
169 - * 'type' => string,
170 - * 'label' => string,
171 - * ]
172 - * ]
182 + * @param string|array[
183 + * [
184 + * 'type' => string,
185 + * 'label' => string
186 + * ]
187 + * ] $tag
173 188 *
174 - * @param string|array $tags A string of comma separated tags, or an array of tags.
175 - *
176 189 * @return array
177 190 */
178 - private function format_feature_tags( $tags ): array {
191 + private function format_feature_tags( $tags ) : array {
179 192 if ( ! is_string( $tags ) && ! is_array( $tags ) ) {
180 193 return [];
181 194 }
182 195
@@ -225,9 +238,9 @@
225 238 *
226 239 * @since 3.1.0
227 240 * @access public
228 241 *
229 - * @param string $feature_name Optional. Default is null.
242 + * @param string $feature_name Optional. Default is null
230 243 *
231 244 * @return array|null
232 245 */
233 246 public function get_features( $feature_name = null ) {
@@ -251,58 +264,20 @@
251 264 *
252 265 * @since 3.1.0
253 266 * @access public
254 267 *
255 - * @param string $feature_name Experiment feature name.
256 - * @param bool $check_dependencies When true, also require dependency experiments to be active.
257 - * Missing dependencies always fail closed. Hidden dependencies are treated as satisfied.
268 + * @param string $feature_name
258 269 *
259 270 * @return bool
260 271 */
261 - public function is_feature_active( $feature_name, $check_dependencies = false ) {
272 + public function is_feature_active( $feature_name ) {
262 273 $feature = $this->get_features( $feature_name );
263 274
264 - if ( ! $feature || self::STATE_ACTIVE !== $this->get_feature_actual_state( $feature ) ) {
275 + if ( ! $feature ) {
265 276 return false;
266 277 }
267 278
268 - if ( isset( $feature['dependencies'] ) && is_array( $feature['dependencies'] ) ) {
269 - foreach ( $feature['dependencies'] as $dependency ) {
270 - $dependent_feature = $this->get_features( $dependency->get_name() );
271 -
272 - // A dependency that Core still does not ship can never be verified as active.
273 - // Non existing dependencies are re-resolved first to cover later registrations.
274 - if ( $dependency instanceof Non_Existing_Dependency && ! $dependent_feature ) {
275 - return false;
276 - }
277 -
278 - if ( ! $dependent_feature ) {
279 - // A Core experiment dependency that no longer resolves fails closed.
280 - // Class dependencies are not experiment names and stay exempt.
281 - if ( $dependency instanceof Wrap_Core_Dependency ) {
282 - return false;
283 - }
284 -
285 - continue;
286 - }
287 -
288 - if ( ! $check_dependencies ) {
289 - continue;
290 - }
291 -
292 - if ( ! empty( $dependent_feature[ static::TYPE_HIDDEN ] ) ) {
293 - continue;
294 - }
295 -
296 - $feature_state = self::STATE_ACTIVE === $this->get_feature_actual_state( $dependent_feature );
297 -
298 - if ( ! $feature_state ) {
299 - return false;
300 - }
301 - }
302 - }
303 -
304 - return true;
279 + return self::STATE_ACTIVE === $this->get_feature_actual_state( $feature );
305 280 }
306 281
307 282 /**
308 283 * Set Feature Default State
@@ -333,37 +308,88 @@
333 308 *
334 309 * @return string
335 310 */
336 311 public function get_feature_option_key( $feature_name ) {
337 - return static::OPTION_PREFIX . $feature_name;
312 + return 'elementor_experiment-' . $feature_name;
338 313 }
339 314
340 315 private function add_default_features() {
341 316 $this->add_feature( [
342 - 'name' => 'e_font_icon_svg',
343 - 'title' => esc_html__( 'Inline Font Icons', 'elementor' ),
317 + 'name' => 'e_dom_optimization',
318 + 'title' => esc_html__( 'Optimized DOM Output', 'elementor' ),
344 319 'tag' => esc_html__( 'Performance', 'elementor' ),
345 - 'description' => sprintf(
346 - '%1$s <a href="https://go.elementor.com/wp-dash-inline-font-awesome/" target="_blank">%2$s</a>',
347 - esc_html__( 'The “Inline Font Icons” will render the icons as inline SVG without loading the Font-Awesome and the eicons libraries and its related CSS files and fonts.', 'elementor' ),
348 - esc_html__( 'Learn more', 'elementor' )
349 - ),
320 + 'description' => esc_html__( 'Developers, Please Note! This experiment includes some markup changes. If you\'ve used custom code in Elementor, you might have experienced a snippet of code not running. Turning this experiment off allows you to keep prior Elementor markup output settings, and have that lovely code running again.', 'elementor' )
321 + . ' <a href="https://go.elementor.com/wp-dash-legacy-optimized-dom/" target="_blank">'
322 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
350 323 'release_status' => self::RELEASE_STATUS_STABLE,
351 324 'new_site' => [
352 325 'default_active' => true,
353 - 'minimum_installation_version' => '3.17.0',
326 + 'minimum_installation_version' => '3.1.0-beta',
354 327 ],
355 328 'generator_tag' => true,
356 329 ] );
357 330
358 331 $this->add_feature( [
332 + 'name' => 'e_optimized_assets_loading',
333 + 'title' => esc_html__( 'Improved Asset Loading', 'elementor' ),
334 + 'tag' => esc_html__( 'Performance', 'elementor' ),
335 + 'description' => esc_html__( 'Please Note! The "Improved Asset Loading" mode reduces the amount of code that is loaded on the page by default. When activated, parts of the infrastructure code will be loaded dynamically, only when needed. Keep in mind that activating this experiment may cause conflicts with incompatible plugins.', 'elementor' )
336 + . ' <a href="https://go.elementor.com/wp-dash-improved-asset-loading/" target="_blank">'
337 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
338 + 'release_status' => self::RELEASE_STATUS_STABLE,
339 + 'new_site' => [
340 + 'default_active' => true,
341 + 'minimum_installation_version' => '3.2.0-beta',
342 + ],
343 + 'generator_tag' => true,
344 + ] );
345 +
346 + $this->add_feature( [
347 + 'name' => 'e_optimized_css_loading',
348 + 'title' => esc_html__( 'Improved CSS Loading', 'elementor' ),
349 + 'tag' => esc_html__( 'Performance', 'elementor' ),
350 + 'description' => esc_html__( 'Please Note! The “Improved CSS Loading” mode reduces the amount of CSS code that is loaded on the page by default. When activated, the CSS code will be loaded, rather inline or in a dedicated file, only when needed. Activating this experiment may cause conflicts with incompatible plugins.', 'elementor' )
351 + . ' <a href="https://go.elementor.com/wp-dash-improved-css-loading/" target="_blank">'
352 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
353 + 'release_status' => self::RELEASE_STATUS_STABLE,
354 + 'new_site' => [
355 + 'default_active' => true,
356 + 'minimum_installation_version' => '3.3.0-beta',
357 + ],
358 + 'generator_tag' => true,
359 + ] );
360 +
361 + $this->add_feature( [
362 + 'name' => 'e_font_icon_svg',
363 + 'title' => esc_html__( 'Inline Font Icons', 'elementor' ),
364 + 'tag' => esc_html__( 'Performance', 'elementor' ),
365 + 'description' => esc_html__( 'The “Inline Font Icons” will render the icons as inline SVG without loading the Font-Awesome and the eicons libraries and its related CSS files and fonts.', 'elementor' )
366 + . ' <a href="https://go.elementor.com/wp-dash-inline-font-awesome/" target="_blank">'
367 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
368 + 'release_status' => self::RELEASE_STATUS_BETA,
369 + 'generator_tag' => true,
370 + ] );
371 +
372 + $this->add_feature( [
373 + 'name' => 'a11y_improvements',
374 + 'title' => esc_html__( 'Accessibility Improvements', 'elementor' ),
375 + 'tag' => esc_html__( 'Performance', 'elementor' ),
376 + 'description' => esc_html__( 'An array of accessibility enhancements in Elementor pages.', 'elementor' )
377 + . '<br><strong>' . esc_html__( 'Please note!', 'elementor' ) . '</strong> ' . esc_html__( 'These enhancements may include some markup changes to existing elementor widgets', 'elementor' )
378 + . ' <a href="https://go.elementor.com/wp-dash-a11y-improvements/" target="_blank">'
379 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
380 + 'release_status' => self::RELEASE_STATUS_STABLE,
381 + 'default' => self::STATE_ACTIVE,
382 + 'generator_tag' => true,
383 + ] );
384 +
385 + $this->add_feature( [
359 386 'name' => 'additional_custom_breakpoints',
360 387 'title' => esc_html__( 'Additional Custom Breakpoints', 'elementor' ),
361 - 'description' => sprintf(
362 - '%1$s <a href="https://go.elementor.com/wp-dash-additional-custom-breakpoints/" target="_blank">%2$s</a>',
363 - esc_html__( 'Get pixel-perfect design for every screen size. You can now add up to 6 customizable breakpoints beyond the default desktop setting: mobile, mobile extra, tablet, tablet extra, laptop, and widescreen.', 'elementor' ),
364 - esc_html__( 'Learn more', 'elementor' )
365 - ),
388 + 'tag' => esc_html__( 'Performance', 'elementor' ),
389 + 'description' => esc_html__( 'Get pixel-perfect design for every screen size. You can now add up to 6 customizable breakpoints beyond the default desktop setting: mobile, mobile extra, tablet, tablet extra, laptop, and widescreen.', 'elementor' )
390 + . ' <a href="https://go.elementor.com/wp-dash-additional-custom-breakpoints/" target="_blank">'
391 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
366 392 'release_status' => self::RELEASE_STATUS_STABLE,
367 393 'default' => self::STATE_ACTIVE,
368 394 'generator_tag' => true,
369 395 ] );
@@ -368,54 +394,59 @@
368 394 'generator_tag' => true,
369 395 ] );
370 396
371 397 $this->add_feature( [
398 + 'name' => 'admin_menu_rearrangement',
399 + 'mutable' => false,
400 + ] );
401 +
402 + $this->add_feature( [
372 403 'name' => 'container',
373 - 'title' => esc_html__( 'Container', 'elementor' ),
374 - 'description' => sprintf(
375 - /* translators: 1: Link opening tag, 2: Link closing tag, 3: Link opening tag, 4: Link closing tag */
376 - esc_html__( 'Create advanced layouts and responsive designs with %1$sFlexbox%2$s and %3$sGrid%4$s container elements.', 'elementor' ),
377 - '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container/">',
378 - '</a>',
379 - '<a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">',
380 - '</a>'
381 - ),
382 - 'release_status' => self::RELEASE_STATUS_STABLE,
404 + 'title' => esc_html__( 'Flexbox Container', 'elementor' ),
405 + 'description' => sprintf( esc_html__(
406 + 'Create advanced layouts and responsive designs with the new %1$sFlexbox Container element%2$s.
407 + This experiment replaces the current section/column structure, but you\'ll still keep your existing
408 + Sections, Inner Sections and Columns and be able to edit them. Ready to give it a try? Check out the %3$sFlexbox playground%4$s.',
409 + 'elementor'
410 + ), '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container/">', '</a>', '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container-playground/">', '</a>'),
411 + 'release_status' => self::RELEASE_STATUS_RC,
383 412 'default' => self::STATE_INACTIVE,
384 - 'new_site' => [
385 - 'default_active' => true,
386 - 'minimum_installation_version' => '3.16.0',
387 - ],
388 413 'messages' => [
389 - 'on_deactivate' => sprintf(
390 - '%1$s <a target="_blank" href="https://go.elementor.com/wp-dash-deactivate-container/">%2$s</a>',
391 - esc_html__( 'Container-based content will be hidden from your site and may not be recoverable in all cases.', 'elementor' ),
392 - esc_html__( 'Learn more', 'elementor' ),
414 + 'on_deactivate' => esc_html__(
415 + 'If you deactivate Flexbox Container, you will permanently delete all content created with containers and lose access to container-based features like Tabs and Menu widgets',
416 + 'elementor'
393 417 ),
394 418 ],
395 419 ] );
396 420
397 421 $this->add_feature( [
398 - 'name' => 'e_optimized_markup',
399 - 'title' => esc_html__( 'Optimized Markup', 'elementor' ),
400 - 'tag' => esc_html__( 'Performance', 'elementor' ),
401 - 'description' => esc_html__( 'Reduce the DOM size by eliminating HTML tags in various elements and widgets. This experiment includes markup changes so it might require updating custom CSS/JS code and cause compatibility issues with third party plugins.', 'elementor' ),
422 + 'name' => 'e_swiper_latest',
423 + 'title' => esc_html__( 'Upgrade Swiper Library', 'elementor' ),
424 + 'description' => esc_html__( 'Prepare your website for future improvements to carousel features by upgrading the Swiper library integrated into your site from v5.36 to v8.45. This experiment includes markup changes so it might require updating custom code and cause compatibility issues with third party plugins.', 'elementor' ),
402 425 'release_status' => self::RELEASE_STATUS_STABLE,
403 - 'default' => self::STATE_INACTIVE,
404 426 'new_site' => [
405 427 'default_active' => true,
406 - 'minimum_installation_version' => '3.30.0',
428 + 'minimum_installation_version' => '3.11.0',
407 429 ],
430 + 'default' => self::STATE_INACTIVE,
408 431 ] );
409 432
410 433 $this->add_feature( [
411 - 'name' => 'e_optimized_css_files',
412 - 'title' => esc_html__( 'Optimized CSS Files', 'elementor' ),
413 - 'tag' => esc_html__( 'Performance', 'elementor' ),
414 - 'description' => esc_html__( 'Keeps external CSS files available and consistent for sites behind page caching or a CDN.', 'elementor' ),
434 + 'name' => 'container_grid',
435 + 'title' => esc_html__( 'Grid Container', 'elementor' ),
436 + 'tag' => esc_html__( 'Feature', 'elementor' ),
437 + /* translators: %1$s Link open tag, %2$s: Link close tag. */
438 + 'description' => sprintf( esc_html__(
439 + 'Create pixel perfect layouts by placing elements in a customizable grid. Activate to add the CSS Grid option to container elements. %1$sLearn more%2$s',
440 + 'elementor'
441 + ), '<a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">', '</a>'),
442 +
415 443 'release_status' => self::RELEASE_STATUS_ALPHA,
416 444 'default' => self::STATE_INACTIVE,
417 - 'generator_tag' => true,
445 + 'hidden' => false,
446 + 'dependencies' => [
447 + 'container',
448 + ],
418 449 ] );
419 450 }
420 451
421 452 /**
@@ -442,8 +473,9 @@
442 473 $this->release_statuses = [
443 474 self::RELEASE_STATUS_DEV => esc_html__( 'Development', 'elementor' ),
444 475 self::RELEASE_STATUS_ALPHA => esc_html__( 'Alpha', 'elementor' ),
445 476 self::RELEASE_STATUS_BETA => esc_html__( 'Beta', 'elementor' ),
477 + self::RELEASE_STATUS_RC => esc_html__( 'Release Candidate', 'elementor' ),
446 478 self::RELEASE_STATUS_STABLE => esc_html__( 'Stable', 'elementor' ),
447 479 ];
448 480 }
449 481
@@ -467,8 +499,9 @@
467 499 * @param Settings $settings
468 500 *
469 501 * @since 3.1.0
470 502 * @access private
503 + *
471 504 */
472 505 private function register_settings_fields( Settings $settings ) {
473 506 $features = $this->get_features();
474 507
@@ -557,9 +590,9 @@
557 590 </h2>
558 591 <p class="e-experiment__description">
559 592 <?php
560 593 printf(
561 - /* translators: %1$s Link open tag, %2$s: Link close tag. */
594 + /* translators: %1$s Link open tag, %2$s: Link close tag. */
562 595 esc_html__( 'Personalize your Elementor experience by controlling which features and experiments are active on your site. Help make Elementor better by %1$ssharing your experience and feedback with us%2$s.', 'elementor' ),
563 596 '<a href="https://go.elementor.com/wp-dash-experiments-report-an-issue/" target="_blank">',
564 597 '</a>'
565 598 );
@@ -566,13 +599,14 @@
566 599 ?>
567 600 </p>
568 601 <p class="e-experiment__description">
569 602 <?php
570 - printf(
571 - '%1$s <a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">%2$s</a>',
572 - esc_html__( 'To use an experiment or feature on your site, simply click on the dropdown next to it and switch to Active. You can always deactivate them at any time.', 'elementor' ),
573 - esc_html__( 'Learn more', 'elementor' ),
574 - );
603 + printf(
604 + /* translators: %1$s Link open tag, %2$s: Link close tag. */
605 + esc_html__( 'To use an experiment or feature on your site, simply click on the dropdown next to it and switch to Active. You can always deactivate them at any time. %1$sLearn More.%2$s', 'elementor' ),
606 + '<a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">',
607 + '</a>'
608 + );
575 609 ?>
576 610 </p>
577 611
578 612 <?php if ( $this->get_features() ) { ?>
@@ -599,9 +633,8 @@
599 633 $control_id = 'e-experiment-' . $feature['name'];
600 634 $control_name = $this->get_feature_option_key( $feature['name'] );
601 635
602 636 $status = sprintf(
603 - /* translators: %s Release status. */
604 637 esc_html__( 'Status: %s', 'elementor' ),
605 638 $this->release_statuses[ $feature['release_status'] ]
606 639 );
607 640
@@ -660,13 +693,13 @@
660 693 ->find( function ( $dependency ) {
661 694 return $dependency instanceof Non_Existing_Dependency;
662 695 } );
663 696
664 - return (bool) $non_existing_dep;
697 + return ! ! $non_existing_dep;
665 698 }
666 699
667 700 /**
668 - * Get Feature Settings Label HTML.
701 + * Get Feature Settings Label HTML
669 702 *
670 703 * @since 3.1.0
671 704 * @access private
672 705 *
@@ -691,16 +724,10 @@
691 724 <div class="e-experiment__title">
692 725 <div class="<?php echo $indicator_classes; ?>" data-tooltip="<?php echo $indicator_tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"></div>
693 726 <label class="e-experiment__title__label" for="e-experiment-<?php echo $feature['name']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"><?php echo $feature['title']; ?></label>
694 727 <?php foreach ( $feature['tags'] as $tag ) { ?>
695 - <?php
696 - $tag_classes = 'e-experiment__title__tag e-experiment__title__tag__' . $tag['type'] . ' e-editor-one';
697 - ?>
698 - <span class="<?php echo esc_attr( $tag_classes ); ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span>
728 + <span class="e-experiment__title__tag e-experiment__title__tag__<?php echo $tag['type']; ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span>
699 729 <?php } ?>
700 - <?php if ( $feature['deprecated'] ) { ?>
701 - <span class="e-experiment__title__tag e-experiment__title__tag__deprecated"><?php echo esc_html__( 'Deprecated', 'elementor' ); ?></span>
702 - <?php } ?>
703 730 </div>
704 731 <?php
705 732
706 733 return ob_get_clean();
@@ -764,11 +791,12 @@
764 791 *
765 792 * @since 3.1.0
766 793 * @access private
767 794 *
768 - * @param array $old_feature_data
795 + * @param array $old_feature_data
769 796 * @param string $new_state
770 - * @param string $old_state
797 + *
798 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
771 799 */
772 800 private function on_feature_state_change( array $old_feature_data, $new_state, $old_state ) {
773 801 $new_feature_data = $this->get_features( $old_feature_data['name'] );
774 802 $this->validate_dependency( $new_feature_data, $new_state );
@@ -785,9 +813,9 @@
785 813 do_action( 'elementor/experiments/feature-state-change/' . $old_feature_data['name'], $old_state, $new_state );
786 814 }
787 815
788 816 /**
789 - * @throws Exceptions\Dependency_Exception If the feature dependency is not available or not active.
817 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
790 818 */
791 819 private function validate_dependency( array $feature, $new_state ) {
792 820 $rollback = function ( $feature_option_key, $state ) {
793 821 remove_all_actions( 'add_option_' . $feature_option_key );
@@ -808,41 +836,20 @@
808 836 }
809 837
810 838 // Validate if the current feature dependency is available.
811 839 foreach ( $feature['dependencies'] as $dependency ) {
812 - if ( $dependency instanceof Non_Existing_Dependency ) {
813 - $this->warn_removed_or_hidden_dependency(
814 - sprintf(
815 - 'The feature `%s` has a dependency `%s` that is not available in Core.',
816 - esc_html( $feature['name'] ),
817 - esc_html( $dependency->get_name() )
818 - )
819 - );
820 - continue;
821 - }
822 -
823 840 $dependency_feature = $this->get_features( $dependency->get_name() );
824 841
825 842 if ( ! $dependency_feature ) {
826 - $this->warn_removed_or_hidden_dependency(
827 - sprintf(
828 - 'The feature `%s` has a dependency `%s` that is not available in Core.',
829 - esc_html( $feature['name'] ),
830 - esc_html( $dependency->get_name() )
831 - )
832 - );
833 - continue;
834 - }
843 + $rollback( $feature_option_key, self::STATE_INACTIVE );
835 844
836 - if ( $this->is_removed_or_hidden_dependency( $dependency_feature ) ) {
837 - $this->warn_removed_or_hidden_dependency(
845 + throw new Exceptions\Dependency_Exception(
838 846 sprintf(
839 - 'The feature `%1$s` depends on hidden experiment `%2$s`.',
840 - esc_html( $feature['name'] ),
841 - esc_html( $dependency_feature['name'] )
847 + 'The feature `%s` has a dependency `%s` that is not available.',
848 + $feature['name'],
849 + $dependency->get_name()
842 850 )
843 851 );
844 - continue;
845 852 }
846 853
847 854 $dependency_state = $this->get_feature_actual_state( $dependency_feature );
848 855
@@ -852,10 +859,10 @@
852 859
853 860 throw new Exceptions\Dependency_Exception(
854 861 sprintf(
855 862 'To turn on `%1$s`, Experiment: `%2$s` activity is required!',
856 - esc_html( $feature['name'] ),
857 - esc_html( $dependency_feature['name'] )
863 + $feature['name'],
864 + $dependency_feature['name']
858 865 )
859 866 );
860 867 }
861 868 }
@@ -892,74 +899,8 @@
892 899
893 900 return new Non_Existing_Dependency( $dependency_name );
894 901 }
895 902
896 - /**
897 - * The experiments page is a WordPress options page, which means all the experiments are registered via WordPress' register_settings(),
898 - * and their states are being sent in the POST request when saving.
899 - * The options are being updated in a chronological order based on the POST data.
900 - * This behavior interferes with the experiments dependency mechanism because the data that's being sent can be in any order,
901 - * while the dependencies mechanism expects it to be in a specific order (dependencies should be activated before their dependents can).
902 - * In order to solve this issue, we sort the experiments in the POST data based on their dependencies tree.
903 - *
904 - * @param array $allowed_options
905 - */
906 - private function sort_allowed_options_by_dependencies( $allowed_options ) {
907 - if ( ! isset( $allowed_options['elementor'] ) ) {
908 - return $allowed_options;
909 - }
910 -
911 - $sorted = Collection::make();
912 - $visited = Collection::make();
913 -
914 - $sort = function ( $item ) use ( &$sort, $sorted, $visited ) {
915 - if ( $visited->contains( $item ) ) {
916 - return;
917 - }
918 -
919 - $visited->push( $item );
920 -
921 - $feature = $this->get_features( $item );
922 -
923 - if ( ! $feature ) {
924 - return;
925 - }
926 -
927 - foreach ( $feature['dependencies'] ?? [] as $dep ) {
928 - $name = is_string( $dep ) ? $dep : $dep->get_name();
929 -
930 - $sort( $name );
931 - }
932 -
933 - $sorted->push( $item );
934 - };
935 -
936 - foreach ( $allowed_options['elementor'] as $option ) {
937 - $is_experiment_option = strpos( $option, static::OPTION_PREFIX ) === 0;
938 -
939 - if ( ! $is_experiment_option ) {
940 - continue;
941 - }
942 -
943 - $sort(
944 - str_replace( static::OPTION_PREFIX, '', $option )
945 - );
946 - }
947 -
948 - $allowed_options['elementor'] = Collection::make( $allowed_options['elementor'] )
949 - ->filter( function ( $option ) {
950 - return 0 !== strpos( $option, static::OPTION_PREFIX );
951 - } )
952 - ->merge(
953 - $sorted->map( function ( $item ) {
954 - return static::OPTION_PREFIX . $item;
955 - } )
956 - )
957 - ->values();
958 -
959 - return $allowed_options;
960 - }
961 -
962 903 public function __construct() {
963 904 $this->init_states();
964 905
965 906 $this->init_release_statuses();
@@ -980,12 +921,8 @@
980 921
981 922 add_action( "elementor/admin/after_create_settings/{$page_id}", function( Settings $settings ) {
982 923 $this->register_settings_fields( $settings );
983 924 }, 11 );
984 -
985 - add_filter( 'allowed_options', function ( $allowed_options ) {
986 - return $this->sort_allowed_options_by_dependencies( $allowed_options );
987 - }, 11 );
988 925 }
989 926
990 927 // Register CLI commands.
991 928 if ( Utils::is_wp_cli() ) {
@@ -990,160 +927,6 @@
990 927 // Register CLI commands.
991 928 if ( Utils::is_wp_cli() ) {
992 929 \WP_CLI::add_command( 'elementor experiments', WP_CLI::class );
993 930 }
994 - }
995 -
996 - /**
997 - * @param array $experimental_data
998 - * @return array
999 - */
1000 - private function initialize_feature_dependencies( array $experimental_data ): array {
1001 - foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
1002 - $feature = $this->get_features( $dependency );
1003 -
1004 - if ( ! isset( $feature ) ) {
1005 - $this->warn_removed_or_hidden_dependency(
1006 - sprintf(
1007 - 'Feature %1$s depends on experiment %2$s that is not registered in Core.',
1008 - esc_html( $experimental_data['name'] ),
1009 - esc_html( $dependency )
1010 - )
1011 - );
1012 -
1013 - $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, null );
1014 - continue;
1015 - }
1016 -
1017 - if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
1018 - $this->warn_removed_or_hidden_dependency(
1019 - sprintf(
1020 - 'Feature %1$s depends on hidden experiment %2$s.',
1021 - esc_html( $experimental_data['name'] ),
1022 - esc_html( $dependency )
1023 - )
1024 - );
1025 - }
1026 -
1027 - $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
1028 - $experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data );
1029 - }
1030 -
1031 - return $experimental_data;
1032 - }
1033 -
1034 - private function is_removed_or_hidden_dependency( $dependency_feature ): bool {
1035 - if ( ! $dependency_feature ) {
1036 - return true;
1037 - }
1038 -
1039 - return ! empty( $dependency_feature[ static::TYPE_HIDDEN ] );
1040 - }
1041 -
1042 - /**
1043 - * Re-resolve non existing dependency placeholders of dependants that were
1044 - * registered before this feature existed.
1045 - *
1046 - * @param string $feature_name Newly registered feature name.
1047 - * @param array $feature_data Newly registered feature data.
1048 - */
1049 - private function resolve_registered_dependants( string $feature_name, array $feature_data ): void {
1050 - foreach ( $this->features as $name => $registered_feature ) {
1051 - if ( $name === $feature_name || empty( $registered_feature['dependencies'] ) || ! is_array( $registered_feature['dependencies'] ) ) {
1052 - continue;
1053 - }
1054 -
1055 - foreach ( $registered_feature['dependencies'] as $key => $dependency ) {
1056 - if ( ! ( $dependency instanceof Non_Existing_Dependency ) || $dependency->get_name() !== $feature_name ) {
1057 - continue;
1058 - }
1059 -
1060 - $this->features[ $name ]['dependencies'][ $key ] = $this->create_dependency_class( $feature_name, $feature_data );
1061 - }
1062 - }
1063 - }
1064 -
1065 - private function warn_removed_or_hidden_dependency( string $message ): void {
1066 - if ( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) {
1067 - return;
1068 - }
1069 -
1070 - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Developer notice; message is escaped.
1071 - _doing_it_wrong( __METHOD__, esc_html( $message ), ELEMENTOR_VERSION );
1072 - }
1073 -
1074 - /**
1075 - * @param array $feature
1076 - * @param array $experimental_data
1077 - * @return array
1078 - *
1079 - * we must validate the state:
1080 - * * A user can set a dependant feature to inactive and in upgrade we don't change users settings.
1081 - * * A developer can set the default state to be invalid (e.g. dependant feature is inactive).
1082 - * if one of the dependencies is inactive, the main feature should be inactive as well.
1083 - */
1084 - private function set_feature_default_state_to_match_dependencies( array $feature, array $experimental_data ): array {
1085 - if ( self::STATE_INACTIVE !== $this->get_feature_actual_state( $feature ) ) {
1086 - return $experimental_data;
1087 - }
1088 -
1089 - if ( self::STATE_ACTIVE === $experimental_data['state'] ) {
1090 - $experimental_data['state'] = self::STATE_INACTIVE;
1091 - } elseif ( self::STATE_DEFAULT === $experimental_data['state'] ) {
1092 - $experimental_data['default'] = self::STATE_INACTIVE;
1093 - }
1094 -
1095 - return $experimental_data;
1096 - }
1097 -
1098 - /**
1099 - * @param array $new_site
1100 - * @param array $experimental_data
1101 - * @return array
1102 - */
1103 - private function set_new_site_default_state( $new_site, array $experimental_data ): array {
1104 - if ( ! $this->install_compare( $new_site['minimum_installation_version'] ) ) {
1105 - return $experimental_data;
1106 - }
1107 -
1108 - if ( $new_site['always_active'] ) {
1109 - $experimental_data['state'] = self::STATE_ACTIVE;
1110 - $experimental_data['mutable'] = false;
1111 - } elseif ( $new_site['default_active'] ) {
1112 - $experimental_data['default'] = self::STATE_ACTIVE;
1113 - } elseif ( $new_site['default_inactive'] ) {
1114 - $experimental_data['default'] = self::STATE_INACTIVE;
1115 - }
1116 -
1117 - return $experimental_data;
1118 - }
1119 -
1120 - /**
1121 - * @param array $options
1122 - * @return array
1123 - */
1124 - private function set_feature_initial_options( array $options ): array {
1125 - $default_experimental_data = [
1126 - 'tag' => '', // Deprecated, use 'tags' instead.
1127 - 'tags' => [],
1128 - 'description' => '',
1129 - 'release_status' => self::RELEASE_STATUS_ALPHA,
1130 - 'default' => self::STATE_INACTIVE,
1131 - 'mutable' => true,
1132 - static::TYPE_HIDDEN => false,
1133 - 'new_site' => [
1134 - 'always_active' => false,
1135 - 'default_active' => false,
1136 - 'default_inactive' => false,
1137 - 'minimum_installation_version' => null,
1138 - ],
1139 - 'on_state_change' => null,
1140 - 'generator_tag' => false,
1141 - 'deprecated' => false,
1142 - ];
1143 -
1144 - $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages', 'deprecated' ];
1145 - $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
1146 -
1147 - return $this->unify_feature_tags( $experimental_data );
1148 931 }
1149 932 }