PluginProbe
Elementor Website Builder – more than just a page builder / 3.7.3
Elementor Website Builder – more than just a page builder v3.7.3
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 | core/experiments/manager.php +227 -472 4.1.13.7.3 View file →
@@ -1,11 +1,9 @@
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 -use Elementor\Core\Utils\Collection;
8 6 use Elementor\Modules\System_Info\Module as System_Info;
9 7 use Elementor\Plugin;
10 8 use Elementor\Settings;
11 9 use Elementor\Tracker;
@@ -11,9 +9,9 @@
11 9 use Elementor\Tracker;
12 10 use Elementor\Utils;
13 11
14 12 if ( ! defined( 'ABSPATH' ) ) {
15 - exit; // Exit if accessed directly.
13 + exit; // Exit if accessed directly
16 14 }
17 15
18 16 class Manager extends Base_Object {
19 17
@@ -22,8 +20,10 @@
22 20 const RELEASE_STATUS_ALPHA = 'alpha';
23 21
24 22 const RELEASE_STATUS_BETA = 'beta';
25 23
24 + const RELEASE_STATUS_RC = 'rc';
25 +
26 26 const RELEASE_STATUS_STABLE = 'stable';
27 27
28 28 const STATE_DEFAULT = 'default';
29 29
@@ -30,12 +30,8 @@
30 30 const STATE_ACTIVE = 'active';
31 31
32 32 const STATE_INACTIVE = 'inactive';
33 33
34 - const TYPE_HIDDEN = 'hidden';
35 -
36 - const OPTION_PREFIX = 'elementor_experiment-';
37 -
38 34 private $states;
39 35
40 36 private $release_statuses;
41 37
@@ -43,26 +39,23 @@
43 39
44 40 /**
45 41 * Add Feature
46 42 *
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 43 * @since 3.1.0
59 44 * @access public
60 45 *
61 - * @param array $options Feature options.
46 + * @param array $options {
47 + * @type string $name
48 + * @type string $title
49 + * @type string $tag
50 + * @type string $description
51 + * @type string $release_status
52 + * @type string $default
53 + * @type callable $on_state_change
54 + * }
55 + *
62 56 * @return array|null
63 - *
64 - * @throws Dependency_Exception If can't change feature state.
57 + * @throws \Exception
65 58 */
66 59 public function add_feature( array $options ) {
67 60 if ( isset( $this->features[ $options['name'] ] ) ) {
68 61 return null;
@@ -67,14 +60,40 @@
67 60 if ( isset( $this->features[ $options['name'] ] ) ) {
68 61 return null;
69 62 }
70 63
71 - $experimental_data = $this->set_feature_initial_options( $options );
64 + $default_experimental_data = [
65 + 'tag' => '',
66 + 'description' => '',
67 + 'release_status' => self::RELEASE_STATUS_ALPHA,
68 + 'default' => self::STATE_INACTIVE,
69 + 'mutable' => true,
70 + 'new_site' => [
71 + 'default_active' => false,
72 + 'always_active' => false,
73 + 'minimum_installation_version' => null,
74 + ],
75 + 'on_state_change' => null,
76 + ];
72 77
78 + $allowed_options = [ 'name', 'title', 'tag', 'description', 'release_status', 'default', 'mutable', 'new_site', 'on_state_change', 'dependencies' ];
79 +
80 + $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
81 +
73 82 $new_site = $experimental_data['new_site'];
74 83
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 );
84 + if ( $new_site['default_active'] || $new_site['always_active'] ) {
85 + $is_new_installation = Upgrade_Manager::install_compare( $new_site['minimum_installation_version'], '>=' );
86 +
87 + if ( $is_new_installation ) {
88 + if ( $new_site['always_active'] ) {
89 + $experimental_data['state'] = self::STATE_ACTIVE;
90 +
91 + $experimental_data['mutable'] = false;
92 + } elseif ( $new_site['default_active'] ) {
93 + $experimental_data['default'] = self::STATE_ACTIVE;
94 + }
95 + }
77 96 }
78 97
79 98 if ( $experimental_data['mutable'] ) {
80 99 $experimental_data['state'] = $this->get_saved_feature_state( $options['name'] );
@@ -84,9 +103,16 @@
84 103 $experimental_data['state'] = self::STATE_DEFAULT;
85 104 }
86 105
87 106 if ( ! empty( $experimental_data['dependencies'] ) ) {
88 - $experimental_data = $this->initialize_feature_dependencies( $experimental_data );
107 + foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
108 + $feature = $this->get_features( $dependency );
109 + if ( ! class_exists( $dependency ) && ! empty( $feature ) ) {
110 + $experimental_data['dependencies'][ $key ] = new Wrap_Core_Dependency( $feature );
111 + } else {
112 + $experimental_data['dependencies'][ $key ] = $dependency::instance();
113 + }
114 + }
89 115 }
90 116
91 117 $this->features[ $options['name'] ] = $experimental_data;
92 118
@@ -94,14 +120,14 @@
94 120 $feature_option_key = $this->get_feature_option_key( $options['name'] );
95 121
96 122 $on_state_change_callback = function( $old_state, $new_state ) use ( $experimental_data, $feature_option_key ) {
97 123 try {
98 - $this->on_feature_state_change( $experimental_data, $new_state, $old_state );
124 + $this->on_feature_state_change( $experimental_data, $new_state, $feature_option_key );
99 125 } catch ( Exceptions\Dependency_Exception $e ) {
100 126 $message = sprintf(
101 127 '<p>%s</p><p><a href="#" onclick="location.href=\'%s\'">%s</a></p>',
102 128 esc_html( $e->getMessage() ),
103 - Settings::get_settings_tab_url( 'experiments' ),
129 + site_url( 'wp-admin/admin.php?page=elementor#tab-experiments' ),
104 130 esc_html__( 'Back', 'elementor' )
105 131 );
106 132
107 133 wp_die( $message ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
@@ -116,98 +142,9 @@
116 142
117 143 return $experimental_data;
118 144 }
119 145
120 - private function install_compare( $version ) {
121 - $installs_history = Upgrade_Manager::get_installs_history();
122 -
123 - if ( empty( $installs_history ) ) {
124 - // Fresh installation: upgrade manager hasn't written history yet on this first request.
125 - // Use the current plugin version as the effective first-install version.
126 - return version_compare( ELEMENTOR_VERSION, $version, '>=' );
127 - }
128 -
129 - $cleaned_version = preg_replace( '/-(beta|cloud|dev)\d*$/', '', key( $installs_history ) );
130 -
131 - return version_compare(
132 - $cleaned_version,
133 - $version,
134 - '>='
135 - );
136 - }
137 -
138 146 /**
139 - * Combine 'tag' and 'tags' into one property.
140 - *
141 - * @param array $experimental_data
142 - *
143 - * @return array
144 - */
145 - private function unify_feature_tags( array $experimental_data ): array {
146 - foreach ( [ 'tag', 'tags' ] as $key ) {
147 - if ( empty( $experimental_data[ $key ] ) ) {
148 - continue;
149 - }
150 -
151 - $experimental_data[ $key ] = $this->format_feature_tags( $experimental_data[ $key ] );
152 - }
153 -
154 - if ( is_array( $experimental_data['tag'] ) ) {
155 - $experimental_data['tags'] = array_merge( $experimental_data['tag'], $experimental_data['tags'] );
156 - }
157 -
158 - return $experimental_data;
159 - }
160 -
161 - /**
162 - * Format feature tags into the right format.
163 - *
164 - * If an array of tags provided, each tag has to provide the following information:
165 - * [
166 - * [
167 - * 'type' => string,
168 - * 'label' => string,
169 - * ]
170 - * ]
171 - *
172 - * @param string|array $tags A string of comma separated tags, or an array of tags.
173 - *
174 - * @return array
175 - */
176 - private function format_feature_tags( $tags ): array {
177 - if ( ! is_string( $tags ) && ! is_array( $tags ) ) {
178 - return [];
179 - }
180 -
181 - $default_tag = [
182 - 'type' => 'default',
183 - 'label' => '',
184 - ];
185 -
186 - $allowed_tag_properties = [ 'type', 'label' ];
187 -
188 - // If $tags is string, explode by commas and convert to array.
189 - if ( is_string( $tags ) ) {
190 - $tags = array_filter( explode( ',', $tags ) );
191 -
192 - foreach ( $tags as $i => $tag ) {
193 - $tags[ $i ] = [ 'label' => trim( $tag ) ];
194 - }
195 - }
196 -
197 - foreach ( $tags as $i => $tag ) {
198 - if ( empty( $tag['label'] ) ) {
199 - unset( $tags[ $i ] );
200 - continue;
201 - }
202 -
203 - $tags[ $i ] = $this->merge_properties( $default_tag, $tag, $allowed_tag_properties );
204 - }
205 -
206 - return $tags;
207 - }
208 -
209 - /**
210 147 * Remove Feature
211 148 *
212 149 * @since 3.1.0
213 150 * @access public
@@ -223,9 +160,9 @@
223 160 *
224 161 * @since 3.1.0
225 162 * @access public
226 163 *
227 - * @param string $feature_name Optional. Default is null.
164 + * @param string $feature_name Optional. Default is null
228 165 *
229 166 * @return array|null
230 167 */
231 168 public function get_features( $feature_name = null ) {
@@ -253,27 +190,16 @@
253 190 * @param string $feature_name
254 191 *
255 192 * @return bool
256 193 */
257 - public function is_feature_active( $feature_name, $check_dependencies = false ) {
194 + public function is_feature_active( $feature_name ) {
258 195 $feature = $this->get_features( $feature_name );
259 196
260 - if ( ! $feature || self::STATE_ACTIVE !== $this->get_feature_actual_state( $feature ) ) {
197 + if ( ! $feature ) {
261 198 return false;
262 199 }
263 200
264 - if ( $check_dependencies && isset( $feature['dependencies'] ) && is_array( $feature['dependencies'] ) ) {
265 - foreach ( $feature['dependencies'] as $dependency ) {
266 - $dependent_feature = $this->get_features( $dependency->get_name() );
267 - $feature_state = self::STATE_ACTIVE === $this->get_feature_actual_state( $dependent_feature );
268 -
269 - if ( ! $feature_state ) {
270 - return false;
271 - }
272 - }
273 - }
274 -
275 - return true;
201 + return self::STATE_ACTIVE === $this->get_feature_actual_state( $feature );
276 202 }
277 203
278 204 /**
279 205 * Set Feature Default State
@@ -304,81 +230,134 @@
304 230 *
305 231 * @return string
306 232 */
307 233 public function get_feature_option_key( $feature_name ) {
308 - return static::OPTION_PREFIX . $feature_name;
234 + return 'elementor_experiment-' . $feature_name;
309 235 }
310 236
311 237 private function add_default_features() {
312 238 $this->add_feature( [
239 + 'name' => 'e_dom_optimization',
240 + 'title' => esc_html__( 'Optimized DOM Output', 'elementor' ),
241 + 'tag' => esc_html__( 'Performance', 'elementor' ),
242 + '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' )
243 + . ' <a href="https://go.elementor.com/wp-dash-legacy-optimized-dom/" target="_blank">'
244 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
245 + 'release_status' => self::RELEASE_STATUS_STABLE,
246 + 'new_site' => [
247 + 'default_active' => true,
248 + 'minimum_installation_version' => '3.1.0-beta',
249 + ],
250 + ] );
251 +
252 + $this->add_feature( [
253 + 'name' => 'e_optimized_assets_loading',
254 + 'title' => esc_html__( 'Improved Asset Loading', 'elementor' ),
255 + 'tag' => esc_html__( 'Performance', 'elementor' ),
256 + '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' )
257 + . ' <a href="https://go.elementor.com/wp-dash-improved-asset-loading/" target="_blank">'
258 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
259 + 'release_status' => self::RELEASE_STATUS_STABLE,
260 + 'new_site' => [
261 + 'default_active' => true,
262 + 'minimum_installation_version' => '3.2.0-beta',
263 + ],
264 + ] );
265 +
266 + $this->add_feature( [
267 + 'name' => 'e_optimized_css_loading',
268 + 'title' => esc_html__( 'Improved CSS Loading', 'elementor' ),
269 + 'tag' => esc_html__( 'Performance', 'elementor' ),
270 + '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' )
271 + . ' <a href="https://go.elementor.com/wp-dash-improved-css-loading/" target="_blank">'
272 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
273 + 'release_status' => self::RELEASE_STATUS_RC,
274 + 'new_site' => [
275 + 'default_active' => true,
276 + 'minimum_installation_version' => '3.3.0-beta',
277 + ],
278 + ] );
279 +
280 + $this->add_feature( [
313 281 'name' => 'e_font_icon_svg',
314 282 'title' => esc_html__( 'Inline Font Icons', 'elementor' ),
315 283 'tag' => esc_html__( 'Performance', 'elementor' ),
316 - 'description' => sprintf(
317 - '%1$s <a href="https://go.elementor.com/wp-dash-inline-font-awesome/" target="_blank">%2$s</a>',
318 - 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' ),
319 - esc_html__( 'Learn more', 'elementor' )
320 - ),
284 + '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' )
285 + . ' <a href="https://go.elementor.com/wp-dash-inline-font-awesome/" target="_blank">'
286 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
287 + 'release_status' => self::RELEASE_STATUS_ALPHA,
288 + ] );
289 +
290 + $this->add_feature( [
291 + 'name' => 'a11y_improvements',
292 + 'title' => esc_html__( 'Accessibility Improvements', 'elementor' ),
293 + 'tag' => esc_html__( 'Performance', 'elementor' ),
294 + 'description' => esc_html__( 'An array of accessibility enhancements in Elementor pages.', 'elementor' )
295 + . '<br><strong>' . esc_html__( 'Please note!', 'elementor' ) . '</strong> ' . esc_html__( 'These enhancements may include some markup changes to existing elementor widgets', 'elementor' )
296 + . ' <a href="https://go.elementor.com/wp-dash-a11y-improvements/" target="_blank">'
297 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
321 298 'release_status' => self::RELEASE_STATUS_STABLE,
322 299 'new_site' => [
323 300 'default_active' => true,
324 - 'minimum_installation_version' => '3.17.0',
301 + 'minimum_installation_version' => '3.1.0-beta',
325 302 ],
326 - 'generator_tag' => true,
327 303 ] );
328 304
329 305 $this->add_feature( [
330 306 'name' => 'additional_custom_breakpoints',
331 307 'title' => esc_html__( 'Additional Custom Breakpoints', 'elementor' ),
332 - 'description' => sprintf(
333 - '%1$s <a href="https://go.elementor.com/wp-dash-additional-custom-breakpoints/" target="_blank">%2$s</a>',
334 - 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' ),
335 - esc_html__( 'Learn more', 'elementor' )
336 - ),
308 + 'tag' => esc_html__( 'Performance', 'elementor' ),
309 + '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' )
310 + . ' <a href="https://go.elementor.com/wp-dash-additional-custom-breakpoints/" target="_blank">'
311 + . esc_html__( 'Learn More', 'elementor' ) . '</a>',
337 312 'release_status' => self::RELEASE_STATUS_STABLE,
338 - 'default' => self::STATE_ACTIVE,
339 - 'generator_tag' => true,
313 + 'new_site' => [
314 + 'default_active' => true,
315 + 'minimum_installation_version' => '3.4.0-beta',
316 + ],
340 317 ] );
341 318
342 319 $this->add_feature( [
343 - 'name' => 'container',
344 - 'title' => esc_html__( 'Container', 'elementor' ),
345 - 'description' => sprintf(
346 - /* translators: 1: Link opening tag, 2: Link closing tag, 3: Link opening tag, 4: Link closing tag, 5: Link opening tag, 6: Link closing tag */
347 - esc_html__( 'Create advanced layouts and responsive designs with %1$sFlexbox%2$s and %3$sGrid%4$s container elements. Give it a try using the %5$sContainer playground%6$s.', 'elementor' ),
348 - '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container/">',
349 - '</a>',
350 - '<a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">',
351 - '</a>',
352 - '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container-playground/">',
353 - '</a>'
354 - ),
320 + 'name' => 'e_import_export',
321 + 'title' => esc_html__( 'Import Export Template Kit', 'elementor' ),
322 + 'tag' => esc_html__( 'Feature', 'elementor' ),
323 + 'description' => esc_html__( 'Design sites faster with a template kit that contains some or all components of a complete site, like templates, content & site settings.', 'elementor' )
324 + . '<br>'
325 + . esc_html__( 'You can import a kit and apply it to your site, or export the elements from this site to be used anywhere else.', 'elementor' ),
355 326 'release_status' => self::RELEASE_STATUS_STABLE,
356 - 'default' => self::STATE_INACTIVE,
327 + 'default' => self::STATE_ACTIVE,
357 328 'new_site' => [
358 329 'default_active' => true,
359 - 'minimum_installation_version' => '3.16.0',
330 + 'minimum_installation_version' => '3.2.0-beta',
360 331 ],
361 - 'messages' => [
362 - 'on_deactivate' => sprintf(
363 - '%1$s <a target="_blank" href="https://go.elementor.com/wp-dash-deactivate-container/">%2$s</a>',
364 - esc_html__( 'Container-based content will be hidden from your site and may not be recoverable in all cases.', 'elementor' ),
365 - esc_html__( 'Learn more', 'elementor' ),
366 - ),
367 - ],
368 332 ] );
369 333
370 334 $this->add_feature( [
371 - 'name' => 'e_optimized_markup',
372 - 'title' => esc_html__( 'Optimized Markup', 'elementor' ),
373 - 'tag' => esc_html__( 'Performance', 'elementor' ),
374 - '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' ),
335 + 'name' => 'e_hidden_wordpress_widgets',
336 + 'title' => esc_html__( 'Hide native WordPress widgets from search results', 'elementor' ),
337 + 'tag' => esc_html__( 'Improvement', 'elementor' ),
338 + 'description' => esc_html__( 'WordPress widgets will not be shown when searching in the editor panel. Instead, these widgets can be found in the “WordPress” dropdown at the bottom of the panel.', 'elementor' ),
375 339 'release_status' => self::RELEASE_STATUS_STABLE,
340 + 'default' => self::STATE_ACTIVE,
341 + ] );
342 +
343 + $this->add_feature( [
344 + 'name' => 'admin_menu_rearrangement',
345 + 'mutable' => false,
346 + ] );
347 +
348 + $this->add_feature( [
349 + 'name' => 'container',
350 + 'title' => esc_html__( 'Flexbox Container', 'elementor' ),
351 + 'tag' => esc_html__( 'Feature', 'elementor' ),
352 + 'description' => sprintf( esc_html__(
353 + 'Create advanced layouts and responsive designs with the new %1$sFlexbox Container element%2$s.
354 + This experiment replaces the current section/column structure, but you\'ll still keep your existing
355 + 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.',
356 + 'elementor'
357 + ), '<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>'),
358 + 'release_status' => self::RELEASE_STATUS_ALPHA,
376 359 'default' => self::STATE_INACTIVE,
377 - 'new_site' => [
378 - 'default_active' => true,
379 - 'minimum_installation_version' => '3.30.0',
380 - ],
381 360 ] );
382 361 }
383 362
384 363 /**
@@ -405,8 +384,9 @@
405 384 $this->release_statuses = [
406 385 self::RELEASE_STATUS_DEV => esc_html__( 'Development', 'elementor' ),
407 386 self::RELEASE_STATUS_ALPHA => esc_html__( 'Alpha', 'elementor' ),
408 387 self::RELEASE_STATUS_BETA => esc_html__( 'Beta', 'elementor' ),
388 + self::RELEASE_STATUS_RC => esc_html__( 'Release Candidate', 'elementor' ),
409 389 self::RELEASE_STATUS_STABLE => esc_html__( 'Stable', 'elementor' ),
410 390 ];
411 391 }
412 392
@@ -430,8 +410,9 @@
430 410 * @param Settings $settings
431 411 *
432 412 * @since 3.1.0
433 413 * @access private
414 + *
434 415 */
435 416 private function register_settings_fields( Settings $settings ) {
436 417 $features = $this->get_features();
437 418
@@ -437,13 +418,9 @@
437 418
438 419 $fields = [];
439 420
440 421 foreach ( $features as $feature_name => $feature ) {
441 - $is_hidden = $feature[ static::TYPE_HIDDEN ];
442 - $is_mutable = $feature['mutable'];
443 - $should_hide_experiment = ! $is_mutable || ( $is_hidden && ! $this->should_show_hidden() ) || $this->has_non_existing_dependency( $feature );
444 -
445 - if ( $should_hide_experiment ) {
422 + if ( ! $feature['mutable'] ) {
446 423 unset( $features[ $feature_name ] );
447 424
448 425 continue;
449 426 }
@@ -478,9 +455,9 @@
478 455 }
479 456
480 457 $settings->add_tab(
481 458 'experiments', [
482 - 'label' => esc_html__( 'Features', 'elementor' ),
459 + 'label' => esc_html__( 'Experiments', 'elementor' ),
483 460 'sections' => [
484 461 'ongoing_experiments' => [
485 462 'callback' => function() {
486 463 $this->render_settings_intro();
@@ -515,34 +492,36 @@
515 492 */
516 493 private function render_settings_intro() {
517 494 ?>
518 495 <h2>
519 - <?php echo esc_html__( 'Experiments and Features', 'elementor' ); ?>
496 + <?php echo esc_html__( 'Elementor Experiments', 'elementor' ); ?>
520 497 </h2>
521 498 <p class="e-experiment__description">
522 499 <?php
523 - printf(
524 - /* translators: %1$s Link open tag, %2$s: Link close tag. */
525 - 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' ),
526 - '<a href="https://go.elementor.com/wp-dash-experiments-report-an-issue/" target="_blank">',
527 - '</a>'
528 - );
500 + printf(
501 + /* translators: %1$s Link open tag, %2$s: Link close tag. */
502 + esc_html__( 'Access new and experimental features from Elementor before they\'re officially released. As these features are still in development, they are likely to change, evolve or even be removed altogether. %1$sLearn More.%2$s', 'elementor' ),
503 + '<a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">',
504 + '</a>'
505 + );
529 506 ?>
530 507 </p>
531 508 <p class="e-experiment__description">
509 + <?php echo esc_html__( 'To use an experiment on your site, simply click on the dropdown next to it and switch to Active. You can always deactivate them at any time.', 'elementor' ); ?>
510 + </p>
511 + <p class="e-experiment__description">
532 512 <?php
533 - printf(
534 - '%1$s <a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">%2$s</a>',
535 - 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' ),
536 - esc_html__( 'Learn more', 'elementor' ),
537 - );
513 + printf(
514 + /* translators: %1$s Link open tag, %2$s: Link close tag. */
515 + esc_html__( 'Your feedback is important - %1$shelp us%2$s improve these features by sharing your thoughts and inputs.', 'elementor' ),
516 + '<a href="https://go.elementor.com/wp-dash-experiments-report-an-issue/" target="_blank">',
517 + '</a>'
518 + );
538 519 ?>
539 520 </p>
540 -
541 521 <?php if ( $this->get_features() ) { ?>
542 - <button type="button" class="button e-experiment__button" value="active"><?php echo esc_html__( 'Activate All', 'elementor' ); ?></button>
543 - <button type="button" class="button e-experiment__button" value="inactive"><?php echo esc_html__( 'Deactivate All', 'elementor' ); ?></button>
544 - <button type="button" class="button e-experiment__button" value="default"><?php echo esc_html__( 'Back to default', 'elementor' ); ?></button>
522 + <button type="button" class="button e-experiment__button" value="active">Activate All Experiments</button>
523 + <button type="button" class="button e-experiment__button" value="inactive">Deactivate All Experiments</button>
545 524 <?php } ?>
546 525 <hr>
547 526 <h2 class="e-experiment__table-title">
548 527 <?php echo esc_html__( 'Ongoing Experiments', 'elementor' ); ?>
@@ -558,78 +537,38 @@
558 537 *
559 538 * @param array $feature
560 539 */
561 540 private function render_feature_settings_field( array $feature ) {
562 - $control_id = 'e-experiment-' . $feature['name'];
563 - $control_name = $this->get_feature_option_key( $feature['name'] );
564 -
565 - $status = sprintf(
566 - /* translators: %s Release status. */
567 - esc_html__( 'Status: %s', 'elementor' ),
568 - $this->release_statuses[ $feature['release_status'] ]
569 - );
570 -
571 541 ?>
572 542 <div class="e-experiment__content">
573 - <select class="e-experiment__select"
574 - id="<?php echo esc_attr( $control_id ); ?>"
575 - name="<?php echo esc_attr( $control_name ); ?>"
576 - data-experiment-id="<?php echo esc_attr( $feature['name'] ); ?>"
577 - >
543 + <select id="e-experiment-<?php echo $feature['name']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>" class="e-experiment__select" name="<?php echo $this->get_feature_option_key( $feature['name'] ); ?>">
578 544 <?php foreach ( $this->states as $state_key => $state_title ) { ?>
579 - <option value="<?php echo esc_attr( $state_key ); ?>"
580 - <?php selected( $state_key, $feature['state'] ); ?>
581 - >
582 - <?php echo esc_html( $state_title ); ?>
583 - </option>
545 + <option value="<?php echo $state_key; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>" <?php selected( $state_key, $feature['state'] ); ?>><?php echo $state_title; ?></option>
584 546 <?php } ?>
585 547 </select>
586 -
587 - <p class="description">
588 - <?php Utils::print_unescaped_internal_string( $feature['description'] ); ?>
589 - </p>
590 -
591 - <?php $this->render_feature_dependency( $feature ); ?>
592 -
548 + <p class="description"><?php echo $feature['description']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></p>
593 549 <?php if ( 'stable' !== $feature['release_status'] ) { ?>
594 - <div class="e-experiment__status">
595 - <?php echo esc_html( $status ); ?>
596 - </div>
550 + <div class="e-experiment__status"><?php echo sprintf( esc_html__( 'Status: %s', 'elementor' ), $this->release_statuses[ $feature['release_status'] ] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></div>
597 551 <?php } ?>
598 552 </div>
599 - <?php
553 + <?php $this->render_feature_dependency( $feature );
600 554 }
601 555
602 556 private function render_feature_dependency( $feature ) {
603 - $dependencies = ( new Collection( $feature['dependencies'] ?? [] ) )
604 - ->map( function ( $dependency ) {
605 - return $dependency->get_title();
606 - } )
607 - ->implode( ', ' );
608 -
609 - if ( empty( $dependencies ) ) {
610 - return;
611 - }
612 -
613 - ?>
557 + if ( ! empty( $feature['dependencies'] ) ) {
558 + ?>
614 559 <div class="e-experiment__dependency">
615 - <strong class="e-experiment__dependency__title"><?php echo esc_html__( 'Requires', 'elementor' ); ?>:</strong>
616 - <span><?php echo esc_html( $dependencies ); ?></span>
560 + <strong class="e-experiment__dependency__title"><?php echo esc_html__( 'Depends on', 'elementor' ); ?>:</strong>
561 + <?php foreach ( $feature['dependencies'] as $dependency ) : ?>
562 + <span class="e-experiment__dependency__item"><?php Utils::print_unescaped_internal_string( $dependency->get_name() ); ?></span>
563 + <?php endforeach; ?>
617 564 </div>
618 - <?php
565 + <?php
566 + }
619 567 }
620 568
621 - private function has_non_existing_dependency( $feature ) {
622 - $non_existing_dep = ( new Collection( $feature['dependencies'] ?? [] ) )
623 - ->find( function ( $dependency ) {
624 - return $dependency instanceof Non_Existing_Dependency;
625 - } );
626 -
627 - return (bool) $non_existing_dep;
628 - }
629 -
630 569 /**
631 - * Get Feature Settings Label HTML.
570 + * Get Feature Settings Label HTML
632 571 *
633 572 * @since 3.1.0
634 573 * @access private
635 574 *
@@ -653,17 +592,11 @@
653 592 ?>
654 593 <div class="e-experiment__title">
655 594 <div class="<?php echo $indicator_classes; ?>" data-tooltip="<?php echo $indicator_tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"></div>
656 595 <label class="e-experiment__title__label" for="e-experiment-<?php echo $feature['name']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"><?php echo $feature['title']; ?></label>
657 - <?php foreach ( $feature['tags'] as $tag ) { ?>
658 - <?php
659 - $tag_classes = 'e-experiment__title__tag e-experiment__title__tag__' . $tag['type'] . ' e-editor-one';
660 - ?>
661 - <span class="<?php echo esc_attr( $tag_classes ); ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span>
662 - <?php } ?>
663 - <?php if ( $feature['deprecated'] ) { ?>
664 - <span class="e-experiment__title__tag e-experiment__title__tag__deprecated"><?php echo esc_html__( 'Deprecated', 'elementor' ); ?></span>
665 - <?php } ?>
596 + <?php if ( ! empty( $feature['tag'] ) ) : ?>
597 + <span class="e-experiment__title__tag"><?php echo $feature['tag']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span>
598 + <?php endif; ?>
666 599 </div>
667 600 <?php
668 601
669 602 return ob_get_clean();
@@ -714,9 +647,9 @@
714 647 *
715 648 * @return string
716 649 */
717 650 private function get_feature_actual_state( array $feature ) {
718 - if ( ! empty( $feature['state'] ) && self::STATE_DEFAULT !== $feature['state'] ) {
651 + if ( self::STATE_DEFAULT !== $feature['state'] ) {
719 652 return $feature['state'];
720 653 }
721 654
722 655 return $feature['default'];
@@ -727,30 +660,37 @@
727 660 *
728 661 * @since 3.1.0
729 662 * @access private
730 663 *
731 - * @param array $old_feature_data
664 + * @param array $old_feature_data
732 665 * @param string $new_state
733 - * @param string $old_state
666 + *
667 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
734 668 */
735 - private function on_feature_state_change( array $old_feature_data, $new_state, $old_state ) {
669 + private function on_feature_state_change( array $old_feature_data, $new_state, $feature_option_key ) {
736 670 $new_feature_data = $this->get_features( $old_feature_data['name'] );
671 +
737 672 $this->validate_dependency( $new_feature_data, $new_state );
673 +
674 + $actual_old_state = $this->get_feature_actual_state( $old_feature_data );
675 +
676 + $actual_new_state = $this->get_feature_actual_state( $new_feature_data );
677 +
738 678 $this->features[ $old_feature_data['name'] ]['state'] = $new_state;
739 - if ( $old_state === $new_state ) {
679 +
680 + if ( $actual_old_state === $actual_new_state ) {
740 681 return;
741 682 }
742 683
743 684 Plugin::$instance->files_manager->clear_cache();
685 +
744 686 if ( $new_feature_data['on_state_change'] ) {
745 - $new_feature_data['on_state_change']( $old_state, $new_state );
687 + $new_feature_data['on_state_change']( $actual_old_state, $actual_new_state );
746 688 }
747 -
748 - do_action( 'elementor/experiments/feature-state-change/' . $old_feature_data['name'], $old_state, $new_state );
749 689 }
750 690
751 691 /**
752 - * @throws Exceptions\Dependency_Exception If the feature dependency is not available or not active.
692 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
753 693 */
754 694 private function validate_dependency( array $feature, $new_state ) {
755 695 $rollback = function ( $feature_option_key, $state ) {
756 696 remove_all_actions( 'add_option_' . $feature_option_key );
@@ -777,12 +717,11 @@
777 717 if ( ! $dependency_feature ) {
778 718 $rollback( $feature_option_key, self::STATE_INACTIVE );
779 719
780 720 throw new Exceptions\Dependency_Exception(
781 - sprintf(
782 - 'The feature `%s` has a dependency `%s` that is not available.',
783 - esc_html( $feature['name'] ),
784 - esc_html( $dependency->get_name() )
721 + sprintf( 'The feature `%s` has a dependency `%s` that is not available.',
722 + $feature['name'],
723 + $dependency->get_name()
785 724 )
786 725 );
787 726 }
788 727
@@ -791,19 +730,20 @@
791 730 // If dependency is not active.
792 731 if ( self::STATE_INACTIVE === $dependency_state ) {
793 732 $rollback( $feature_option_key, self::STATE_INACTIVE );
794 733
734 + /* translators: 1: feature_name_that_change_state, 2: dependency_feature_name. */
795 735 throw new Exceptions\Dependency_Exception(
796 736 sprintf(
797 - 'To turn on `%1$s`, Experiment: `%2$s` activity is required!',
798 - esc_html( $feature['name'] ),
799 - esc_html( $dependency_feature['name'] )
737 + esc_html__( 'To turn on `%1$s`, Experiment: `%2$s` activity is required!', 'elementor' ),
738 + $feature['name'],
739 + $dependency_feature['name']
800 740 )
801 741 );
802 742 }
803 743 }
804 744 } elseif ( self::STATE_INACTIVE === $new_state ) {
805 - // Make sure to deactivate a dependant experiment of the current feature when it's deactivated.
745 + // Validate if current feature that goes 'inactive' is not a dependency of current active feature.
806 746 foreach ( $this->get_features() as $current_feature ) {
807 747 if ( empty( $current_feature['dependencies'] ) ) {
808 748 continue;
809 749 }
@@ -811,9 +751,18 @@
811 751 $current_feature_state = $this->get_feature_actual_state( $current_feature );
812 752
813 753 foreach ( $current_feature['dependencies'] as $dependency ) {
814 754 if ( self::STATE_ACTIVE === $current_feature_state && $feature['name'] === $dependency->get_name() ) {
815 - update_option( $this->get_feature_option_key( $current_feature['name'] ), static::STATE_INACTIVE );
755 + $rollback( $feature_option_key, self::STATE_ACTIVE );
756 +
757 + /* translators: 1: feature_name_that_change_state, 2: dependency_feature_name. */
758 + throw new Exceptions\Dependency_Exception(
759 + sprintf(
760 + esc_html__( 'Cannot turn off `%1$s`, Experiment: `%2$s` is still active!', 'elementor' ),
761 + $feature['name'],
762 + $current_feature['name']
763 + )
764 + );
816 765 }
817 766 }
818 767 }
819 768 }
@@ -818,90 +767,8 @@
818 767 }
819 768 }
820 769 }
821 770
822 - private function should_show_hidden() {
823 - return defined( 'ELEMENTOR_SHOW_HIDDEN_EXPERIMENTS' ) && ELEMENTOR_SHOW_HIDDEN_EXPERIMENTS;
824 - }
825 -
826 - private function create_dependency_class( $dependency_name, $dependency_args ) {
827 - if ( class_exists( $dependency_name ) ) {
828 - return $dependency_name::instance();
829 - }
830 -
831 - if ( ! empty( $dependency_args ) ) {
832 - return new Wrap_Core_Dependency( $dependency_args );
833 - }
834 -
835 - return new Non_Existing_Dependency( $dependency_name );
836 - }
837 -
838 - /**
839 - * The experiments page is a WordPress options page, which means all the experiments are registered via WordPress' register_settings(),
840 - * and their states are being sent in the POST request when saving.
841 - * The options are being updated in a chronological order based on the POST data.
842 - * This behavior interferes with the experiments dependency mechanism because the data that's being sent can be in any order,
843 - * while the dependencies mechanism expects it to be in a specific order (dependencies should be activated before their dependents can).
844 - * In order to solve this issue, we sort the experiments in the POST data based on their dependencies tree.
845 - *
846 - * @param array $allowed_options
847 - */
848 - private function sort_allowed_options_by_dependencies( $allowed_options ) {
849 - if ( ! isset( $allowed_options['elementor'] ) ) {
850 - return $allowed_options;
851 - }
852 -
853 - $sorted = Collection::make();
854 - $visited = Collection::make();
855 -
856 - $sort = function ( $item ) use ( &$sort, $sorted, $visited ) {
857 - if ( $visited->contains( $item ) ) {
858 - return;
859 - }
860 -
861 - $visited->push( $item );
862 -
863 - $feature = $this->get_features( $item );
864 -
865 - if ( ! $feature ) {
866 - return;
867 - }
868 -
869 - foreach ( $feature['dependencies'] ?? [] as $dep ) {
870 - $name = is_string( $dep ) ? $dep : $dep->get_name();
871 -
872 - $sort( $name );
873 - }
874 -
875 - $sorted->push( $item );
876 - };
877 -
878 - foreach ( $allowed_options['elementor'] as $option ) {
879 - $is_experiment_option = strpos( $option, static::OPTION_PREFIX ) === 0;
880 -
881 - if ( ! $is_experiment_option ) {
882 - continue;
883 - }
884 -
885 - $sort(
886 - str_replace( static::OPTION_PREFIX, '', $option )
887 - );
888 - }
889 -
890 - $allowed_options['elementor'] = Collection::make( $allowed_options['elementor'] )
891 - ->filter( function ( $option ) {
892 - return 0 !== strpos( $option, static::OPTION_PREFIX );
893 - } )
894 - ->merge(
895 - $sorted->map( function ( $item ) {
896 - return static::OPTION_PREFIX . $item;
897 - } )
898 - )
899 - ->values();
900 -
901 - return $allowed_options;
902 - }
903 -
904 771 public function __construct() {
905 772 $this->init_states();
906 773
907 774 $this->init_release_statuses();
@@ -922,12 +789,8 @@
922 789
923 790 add_action( "elementor/admin/after_create_settings/{$page_id}", function( Settings $settings ) {
924 791 $this->register_settings_fields( $settings );
925 792 }, 11 );
926 -
927 - add_filter( 'allowed_options', function ( $allowed_options ) {
928 - return $this->sort_allowed_options_by_dependencies( $allowed_options );
929 - }, 11 );
930 793 }
931 794
932 795 // Register CLI commands.
933 796 if ( Utils::is_wp_cli() ) {
@@ -932,114 +795,6 @@
932 795 // Register CLI commands.
933 796 if ( Utils::is_wp_cli() ) {
934 797 \WP_CLI::add_command( 'elementor experiments', WP_CLI::class );
935 798 }
936 - }
937 -
938 - /**
939 - * @param array $experimental_data
940 - * @return array
941 - *
942 - * @throws Exceptions\Dependency_Exception If the feature dependency is not initialized or depends on a hidden experiment.
943 - */
944 - private function initialize_feature_dependencies( array $experimental_data ): array {
945 - foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
946 - $feature = $this->get_features( $dependency );
947 -
948 - if ( ! isset( $feature ) ) {
949 - // since we must validate the state of each dependency, we have to make sure that dependencies are initialized in the correct order, otherwise, error.
950 - throw new Exceptions\Dependency_Exception(
951 - sprintf(
952 - 'Feature %s cannot be initialized before dependency feature: %s.',
953 - esc_html( $experimental_data['name'] ),
954 - esc_html( $dependency )
955 - )
956 - );
957 - }
958 -
959 - if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
960 - throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
961 - }
962 -
963 - $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
964 - $experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data );
965 - }
966 -
967 - return $experimental_data;
968 - }
969 -
970 - /**
971 - * @param array $feature
972 - * @param array $experimental_data
973 - * @return array
974 - *
975 - * we must validate the state:
976 - * * A user can set a dependant feature to inactive and in upgrade we don't change users settings.
977 - * * A developer can set the default state to be invalid (e.g. dependant feature is inactive).
978 - * if one of the dependencies is inactive, the main feature should be inactive as well.
979 - */
980 - private function set_feature_default_state_to_match_dependencies( array $feature, array $experimental_data ): array {
981 - if ( self::STATE_INACTIVE !== $this->get_feature_actual_state( $feature ) ) {
982 - return $experimental_data;
983 - }
984 -
985 - if ( self::STATE_ACTIVE === $experimental_data['state'] ) {
986 - $experimental_data['state'] = self::STATE_INACTIVE;
987 - } elseif ( self::STATE_DEFAULT === $experimental_data['state'] ) {
988 - $experimental_data['default'] = self::STATE_INACTIVE;
989 - }
990 -
991 - return $experimental_data;
992 - }
993 -
994 - /**
995 - * @param array $new_site
996 - * @param array $experimental_data
997 - * @return array
998 - */
999 - private function set_new_site_default_state( $new_site, array $experimental_data ): array {
1000 - if ( ! $this->install_compare( $new_site['minimum_installation_version'] ) ) {
1001 - return $experimental_data;
1002 - }
1003 -
1004 - if ( $new_site['always_active'] ) {
1005 - $experimental_data['state'] = self::STATE_ACTIVE;
1006 - $experimental_data['mutable'] = false;
1007 - } elseif ( $new_site['default_active'] ) {
1008 - $experimental_data['default'] = self::STATE_ACTIVE;
1009 - } elseif ( $new_site['default_inactive'] ) {
1010 - $experimental_data['default'] = self::STATE_INACTIVE;
1011 - }
1012 -
1013 - return $experimental_data;
1014 - }
1015 -
1016 - /**
1017 - * @param array $options
1018 - * @return array
1019 - */
1020 - private function set_feature_initial_options( array $options ): array {
1021 - $default_experimental_data = [
1022 - 'tag' => '', // Deprecated, use 'tags' instead.
1023 - 'tags' => [],
1024 - 'description' => '',
1025 - 'release_status' => self::RELEASE_STATUS_ALPHA,
1026 - 'default' => self::STATE_INACTIVE,
1027 - 'mutable' => true,
1028 - static::TYPE_HIDDEN => false,
1029 - 'new_site' => [
1030 - 'always_active' => false,
1031 - 'default_active' => false,
1032 - 'default_inactive' => false,
1033 - 'minimum_installation_version' => null,
1034 - ],
1035 - 'on_state_change' => null,
1036 - 'generator_tag' => false,
1037 - 'deprecated' => false,
1038 - ];
1039 -
1040 - $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages', 'deprecated' ];
1041 - $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
1042 -
1043 - return $this->unify_feature_tags( $experimental_data );
1044 799 }
1045 800 }