PluginProbe
Elementor Website Builder – more than just a page builder / 3.20.2
Elementor Website Builder – more than just a page builder v3.20.2
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 +155 -195 4.2.03.20.2 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
@@ -43,26 +44,24 @@
43 44
44 45 /**
45 46 * Add Feature
46 47 *
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 48 * @since 3.1.0
59 49 * @access public
60 50 *
61 - * @param array $options Feature options.
51 + * @param array $options {
52 + * @type string $name
53 + * @type string $title
54 + * @type string $tag
55 + * @type array $tags
56 + * @type string $description
57 + * @type string $release_status
58 + * @type string $default
59 + * @type callable $on_state_change
60 + * }
61 + *
62 62 * @return array|null
63 - *
64 - * @throws Dependency_Exception If can't change feature state.
63 + * @throws \Exception
65 64 */
66 65 public function add_feature( array $options ) {
67 66 if ( isset( $this->features[ $options['name'] ] ) ) {
68 67 return null;
@@ -67,14 +66,45 @@
67 66 if ( isset( $this->features[ $options['name'] ] ) ) {
68 67 return null;
69 68 }
70 69
71 - $experimental_data = $this->set_feature_initial_options( $options );
70 + $default_experimental_data = [
71 + 'tag' => '', // Deprecated, use 'tags' instead.
72 + 'tags' => [],
73 + 'description' => '',
74 + 'release_status' => self::RELEASE_STATUS_ALPHA,
75 + 'default' => self::STATE_INACTIVE,
76 + 'mutable' => true,
77 + static::TYPE_HIDDEN => false,
78 + 'new_site' => [
79 + 'default_active' => false,
80 + 'always_active' => false,
81 + 'minimum_installation_version' => null,
82 + ],
83 + 'on_state_change' => null,
84 + 'generator_tag' => false,
85 + ];
72 86
87 + $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages' ];
88 +
89 + $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
90 +
91 + $experimental_data = $this->unify_feature_tags( $experimental_data );
92 +
73 93 $new_site = $experimental_data['new_site'];
74 94
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 );
95 + if ( $new_site['default_active'] || $new_site['always_active'] ) {
96 + $is_new_installation = $this->install_compare( $new_site['minimum_installation_version'] );
97 +
98 + if ( $is_new_installation ) {
99 + if ( $new_site['always_active'] ) {
100 + $experimental_data['state'] = self::STATE_ACTIVE;
101 +
102 + $experimental_data['mutable'] = false;
103 + } elseif ( $new_site['default_active'] ) {
104 + $experimental_data['default'] = self::STATE_ACTIVE;
105 + }
106 + }
77 107 }
78 108
79 109 if ( $experimental_data['mutable'] ) {
80 110 $experimental_data['state'] = $this->get_saved_feature_state( $options['name'] );
@@ -84,9 +114,17 @@
84 114 $experimental_data['state'] = self::STATE_DEFAULT;
85 115 }
86 116
87 117 if ( ! empty( $experimental_data['dependencies'] ) ) {
88 - $experimental_data = $this->initialize_feature_dependencies( $experimental_data );
118 + foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
119 + $feature = $this->get_features( $dependency );
120 +
121 + if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
122 + throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
123 + }
124 +
125 + $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
126 + }
89 127 }
90 128
91 129 $this->features[ $options['name'] ] = $experimental_data;
92 130
@@ -99,9 +137,9 @@
99 137 } catch ( Exceptions\Dependency_Exception $e ) {
100 138 $message = sprintf(
101 139 '<p>%s</p><p><a href="#" onclick="location.href=\'%s\'">%s</a></p>',
102 140 esc_html( $e->getMessage() ),
103 - Settings::get_settings_tab_url( 'experiments' ),
141 + site_url( 'wp-admin/admin.php?page=elementor#tab-experiments' ),
104 142 esc_html__( 'Back', 'elementor' )
105 143 );
106 144
107 145 wp_die( $message ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
@@ -120,11 +158,9 @@
120 158 private function install_compare( $version ) {
121 159 $installs_history = Upgrade_Manager::get_installs_history();
122 160
123 161 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, '>=' );
162 + return false;
127 163 }
128 164
129 165 $cleaned_version = preg_replace( '/-(beta|cloud|dev)\d*$/', '', key( $installs_history ) );
130 166
@@ -141,9 +177,9 @@
141 177 * @param array $experimental_data
142 178 *
143 179 * @return array
144 180 */
145 - private function unify_feature_tags( array $experimental_data ): array {
181 + private function unify_feature_tags( array $experimental_data ) : array {
146 182 foreach ( [ 'tag', 'tags' ] as $key ) {
147 183 if ( empty( $experimental_data[ $key ] ) ) {
148 184 continue;
149 185 }
@@ -160,21 +196,18 @@
160 196
161 197 /**
162 198 * Format feature tags into the right format.
163 199 *
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 - * ]
200 + * @param string|array[
201 + * [
202 + * 'type' => string,
203 + * 'label' => string
204 + * ]
205 + * ] $tag
171 206 *
172 - * @param string|array $tags A string of comma separated tags, or an array of tags.
173 - *
174 207 * @return array
175 208 */
176 - private function format_feature_tags( $tags ): array {
209 + private function format_feature_tags( $tags ) : array {
177 210 if ( ! is_string( $tags ) && ! is_array( $tags ) ) {
178 211 return [];
179 212 }
180 213
@@ -223,9 +256,9 @@
223 256 *
224 257 * @since 3.1.0
225 258 * @access public
226 259 *
227 - * @param string $feature_name Optional. Default is null.
260 + * @param string $feature_name Optional. Default is null
228 261 *
229 262 * @return array|null
230 263 */
231 264 public function get_features( $feature_name = null ) {
@@ -253,27 +286,16 @@
253 286 * @param string $feature_name
254 287 *
255 288 * @return bool
256 289 */
257 - public function is_feature_active( $feature_name, $check_dependencies = false ) {
290 + public function is_feature_active( $feature_name ) {
258 291 $feature = $this->get_features( $feature_name );
259 292
260 - if ( ! $feature || self::STATE_ACTIVE !== $this->get_feature_actual_state( $feature ) ) {
293 + if ( ! $feature ) {
261 294 return false;
262 295 }
263 296
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;
297 + return self::STATE_ACTIVE === $this->get_feature_actual_state( $feature );
276 298 }
277 299
278 300 /**
279 301 * Set Feature Default State
@@ -309,8 +331,39 @@
309 331 }
310 332
311 333 private function add_default_features() {
312 334 $this->add_feature( [
335 + 'name' => 'e_optimized_assets_loading',
336 + 'title' => esc_html__( 'Improved Asset Loading', 'elementor' ),
337 + 'tag' => esc_html__( 'Performance', 'elementor' ),
338 + 'description' => sprintf(
339 + '%1$s <a href="https://go.elementor.com/wp-dash-improved-asset-loading/" target="_blank">%2$s</a>',
340 + 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' ),
341 + esc_html__( 'Learn more', 'elementor' )
342 + ),
343 + 'release_status' => self::RELEASE_STATUS_STABLE,
344 + 'default' => self::STATE_ACTIVE,
345 + 'generator_tag' => true,
346 + ] );
347 +
348 + $this->add_feature( [
349 + 'name' => 'e_optimized_css_loading',
350 + 'title' => esc_html__( 'Improved CSS Loading', 'elementor' ),
351 + 'tag' => esc_html__( 'Performance', 'elementor' ),
352 + 'description' => sprintf(
353 + '%1$s <a href="https://go.elementor.com/wp-dash-improved-css-loading/" target="_blank">%2$s</a>',
354 + 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' ),
355 + esc_html__( 'Learn more', 'elementor' )
356 + ),
357 + 'release_status' => self::RELEASE_STATUS_STABLE,
358 + 'new_site' => [
359 + 'default_active' => true,
360 + 'minimum_installation_version' => '3.3.0',
361 + ],
362 + 'generator_tag' => true,
363 + ] );
364 +
365 + $this->add_feature( [
313 366 'name' => 'e_font_icon_svg',
314 367 'title' => esc_html__( 'Inline Font Icons', 'elementor' ),
315 368 'tag' => esc_html__( 'Performance', 'elementor' ),
316 369 'description' => sprintf(
@@ -328,8 +381,9 @@
328 381
329 382 $this->add_feature( [
330 383 'name' => 'additional_custom_breakpoints',
331 384 'title' => esc_html__( 'Additional Custom Breakpoints', 'elementor' ),
385 + 'tag' => esc_html__( 'Performance', 'elementor' ),
332 386 'description' => sprintf(
333 387 '%1$s <a href="https://go.elementor.com/wp-dash-additional-custom-breakpoints/" target="_blank">%2$s</a>',
334 388 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 389 esc_html__( 'Learn more', 'elementor' )
@@ -339,16 +393,25 @@
339 393 'generator_tag' => true,
340 394 ] );
341 395
342 396 $this->add_feature( [
397 + 'name' => 'admin_menu_rearrangement',
398 + 'mutable' => false,
399 + ] );
400 +
401 + $this->add_feature( [
343 402 'name' => 'container',
344 - 'title' => esc_html__( 'Container', 'elementor' ),
403 + 'title' => esc_html__( 'Flexbox Container', 'elementor' ),
345 404 'description' => sprintf(
346 - /* translators: 1: Link opening tag, 2: Link closing tag, 3: Link opening tag, 4: Link closing tag */
347 - esc_html__( 'Create advanced layouts and responsive designs with %1$sFlexbox%2$s and %3$sGrid%4$s container elements.', 'elementor' ),
405 + 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 + ),
348 411 '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container/">',
349 412 '</a>',
350 - '<a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">',
413 + '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container-playground/">',
351 414 '</a>'
352 415 ),
353 416 'release_status' => self::RELEASE_STATUS_STABLE,
354 417 'default' => self::STATE_INACTIVE,
@@ -365,28 +428,34 @@
365 428 ],
366 429 ] );
367 430
368 431 $this->add_feature( [
369 - 'name' => 'e_optimized_markup',
370 - 'title' => esc_html__( 'Optimized Markup', 'elementor' ),
371 - 'tag' => esc_html__( 'Performance', 'elementor' ),
372 - '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' ),
432 + 'name' => 'e_swiper_latest',
433 + 'title' => esc_html__( 'Upgrade Swiper Library', 'elementor' ),
434 + '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' ),
373 435 'release_status' => self::RELEASE_STATUS_STABLE,
436 + 'default' => self::STATE_ACTIVE,
437 + ] );
438 +
439 + $this->add_feature( [
440 + 'name' => 'container_grid',
441 + 'title' => esc_html__( 'Grid Container', 'elementor' ),
442 + 'tag' => esc_html__( 'Feature', 'elementor' ),
443 + 'description' => sprintf(
444 + '%1$s <a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">%2$s</a>',
445 + esc_html__( 'Create pixel perfect layouts by placing elements in a customizable grid. Activate to add the CSS Grid option to container elements.', 'elementor' ),
446 + esc_html__( 'Learn more', 'elementor' ),
447 + ),
448 + 'release_status' => self::RELEASE_STATUS_BETA,
374 449 'default' => self::STATE_INACTIVE,
375 450 'new_site' => [
376 451 'default_active' => true,
377 - 'minimum_installation_version' => '3.30.0',
452 + 'minimum_installation_version' => '3.20.0',
378 453 ],
454 + 'dependencies' => [
455 + 'container',
456 + ],
379 457 ] );
380 -
381 - $this->add_feature( [
382 - 'name' => 'e_panel_promotions',
383 - 'title' => esc_html__( 'Panel Promotions', 'elementor' ),
384 - 'description' => esc_html__( 'Enable experimental rendering for targeted promotions within the elements panels.', 'elementor' ),
385 - 'release_status' => self::RELEASE_STATUS_DEV,
386 - 'default' => self::STATE_ACTIVE,
387 - 'type' => self::TYPE_HIDDEN,
388 - ] );
389 458 }
390 459
391 460 /**
392 461 * Init States
@@ -412,8 +481,9 @@
412 481 $this->release_statuses = [
413 482 self::RELEASE_STATUS_DEV => esc_html__( 'Development', 'elementor' ),
414 483 self::RELEASE_STATUS_ALPHA => esc_html__( 'Alpha', 'elementor' ),
415 484 self::RELEASE_STATUS_BETA => esc_html__( 'Beta', 'elementor' ),
485 + self::RELEASE_STATUS_RC => esc_html__( 'Release Candidate', 'elementor' ),
416 486 self::RELEASE_STATUS_STABLE => esc_html__( 'Stable', 'elementor' ),
417 487 ];
418 488 }
419 489
@@ -437,8 +507,9 @@
437 507 * @param Settings $settings
438 508 *
439 509 * @since 3.1.0
440 510 * @access private
511 + *
441 512 */
442 513 private function register_settings_fields( Settings $settings ) {
443 514 $features = $this->get_features();
444 515
@@ -526,9 +597,9 @@
526 597 <?php echo esc_html__( 'Experiments and Features', 'elementor' ); ?>
527 598 </h2>
528 599 <p class="e-experiment__description">
529 600 <?php
530 - printf(
601 + echo sprintf(
531 602 /* translators: %1$s Link open tag, %2$s: Link close tag. */
532 603 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' ),
533 604 '<a href="https://go.elementor.com/wp-dash-experiments-report-an-issue/" target="_blank">',
534 605 '</a>'
@@ -536,9 +607,9 @@
536 607 ?>
537 608 </p>
538 609 <p class="e-experiment__description">
539 610 <?php
540 - printf(
611 + echo sprintf(
541 612 '%1$s <a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">%2$s</a>',
542 613 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' ),
543 614 esc_html__( 'Learn more', 'elementor' ),
544 615 );
@@ -630,13 +701,13 @@
630 701 ->find( function ( $dependency ) {
631 702 return $dependency instanceof Non_Existing_Dependency;
632 703 } );
633 704
634 - return (bool) $non_existing_dep;
705 + return ! ! $non_existing_dep;
635 706 }
636 707
637 708 /**
638 - * Get Feature Settings Label HTML.
709 + * Get Feature Settings Label HTML
639 710 *
640 711 * @since 3.1.0
641 712 * @access private
642 713 *
@@ -661,16 +732,10 @@
661 732 <div class="e-experiment__title">
662 733 <div class="<?php echo $indicator_classes; ?>" data-tooltip="<?php echo $indicator_tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"></div>
663 734 <label class="e-experiment__title__label" for="e-experiment-<?php echo $feature['name']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"><?php echo $feature['title']; ?></label>
664 735 <?php foreach ( $feature['tags'] as $tag ) { ?>
665 - <?php
666 - $tag_classes = 'e-experiment__title__tag e-experiment__title__tag__' . $tag['type'] . ' e-editor-one';
667 - ?>
668 - <span class="<?php echo esc_attr( $tag_classes ); ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span>
736 + <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>
669 737 <?php } ?>
670 - <?php if ( $feature['deprecated'] ) { ?>
671 - <span class="e-experiment__title__tag e-experiment__title__tag__deprecated"><?php echo esc_html__( 'Deprecated', 'elementor' ); ?></span>
672 - <?php } ?>
673 738 </div>
674 739 <?php
675 740
676 741 return ob_get_clean();
@@ -734,11 +799,12 @@
734 799 *
735 800 * @since 3.1.0
736 801 * @access private
737 802 *
738 - * @param array $old_feature_data
803 + * @param array $old_feature_data
739 804 * @param string $new_state
740 - * @param string $old_state
805 + *
806 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
741 807 */
742 808 private function on_feature_state_change( array $old_feature_data, $new_state, $old_state ) {
743 809 $new_feature_data = $this->get_features( $old_feature_data['name'] );
744 810 $this->validate_dependency( $new_feature_data, $new_state );
@@ -755,9 +821,9 @@
755 821 do_action( 'elementor/experiments/feature-state-change/' . $old_feature_data['name'], $old_state, $new_state );
756 822 }
757 823
758 824 /**
759 - * @throws Exceptions\Dependency_Exception If the feature dependency is not available or not active.
825 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
760 826 */
761 827 private function validate_dependency( array $feature, $new_state ) {
762 828 $rollback = function ( $feature_option_key, $state ) {
763 829 remove_all_actions( 'add_option_' . $feature_option_key );
@@ -786,10 +852,10 @@
786 852
787 853 throw new Exceptions\Dependency_Exception(
788 854 sprintf(
789 855 'The feature `%s` has a dependency `%s` that is not available.',
790 - esc_html( $feature['name'] ),
791 - esc_html( $dependency->get_name() )
856 + $feature['name'],
857 + $dependency->get_name()
792 858 )
793 859 );
794 860 }
795 861
@@ -801,10 +867,10 @@
801 867
802 868 throw new Exceptions\Dependency_Exception(
803 869 sprintf(
804 870 'To turn on `%1$s`, Experiment: `%2$s` activity is required!',
805 - esc_html( $feature['name'] ),
806 - esc_html( $dependency_feature['name'] )
871 + $feature['name'],
872 + $dependency_feature['name']
807 873 )
808 874 );
809 875 }
810 876 }
@@ -849,9 +915,11 @@
849 915 * This behavior interferes with the experiments dependency mechanism because the data that's being sent can be in any order,
850 916 * while the dependencies mechanism expects it to be in a specific order (dependencies should be activated before their dependents can).
851 917 * In order to solve this issue, we sort the experiments in the POST data based on their dependencies tree.
852 918 *
853 - * @param array $allowed_options
919 + * @param $allowed_options
920 + *
921 + * @return mixed
854 922 */
855 923 private function sort_allowed_options_by_dependencies( $allowed_options ) {
856 924 if ( ! isset( $allowed_options['elementor'] ) ) {
857 925 return $allowed_options;
@@ -939,114 +1007,6 @@
939 1007 // Register CLI commands.
940 1008 if ( Utils::is_wp_cli() ) {
941 1009 \WP_CLI::add_command( 'elementor experiments', WP_CLI::class );
942 1010 }
943 - }
944 -
945 - /**
946 - * @param array $experimental_data
947 - * @return array
948 - *
949 - * @throws Exceptions\Dependency_Exception If the feature dependency is not initialized or depends on a hidden experiment.
950 - */
951 - private function initialize_feature_dependencies( array $experimental_data ): array {
952 - foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
953 - $feature = $this->get_features( $dependency );
954 -
955 - if ( ! isset( $feature ) ) {
956 - // since we must validate the state of each dependency, we have to make sure that dependencies are initialized in the correct order, otherwise, error.
957 - throw new Exceptions\Dependency_Exception(
958 - sprintf(
959 - 'Feature %s cannot be initialized before dependency feature: %s.',
960 - esc_html( $experimental_data['name'] ),
961 - esc_html( $dependency )
962 - )
963 - );
964 - }
965 -
966 - if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
967 - throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
968 - }
969 -
970 - $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
971 - $experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data );
972 - }
973 -
974 - return $experimental_data;
975 - }
976 -
977 - /**
978 - * @param array $feature
979 - * @param array $experimental_data
980 - * @return array
981 - *
982 - * we must validate the state:
983 - * * A user can set a dependant feature to inactive and in upgrade we don't change users settings.
984 - * * A developer can set the default state to be invalid (e.g. dependant feature is inactive).
985 - * if one of the dependencies is inactive, the main feature should be inactive as well.
986 - */
987 - private function set_feature_default_state_to_match_dependencies( array $feature, array $experimental_data ): array {
988 - if ( self::STATE_INACTIVE !== $this->get_feature_actual_state( $feature ) ) {
989 - return $experimental_data;
990 - }
991 -
992 - if ( self::STATE_ACTIVE === $experimental_data['state'] ) {
993 - $experimental_data['state'] = self::STATE_INACTIVE;
994 - } elseif ( self::STATE_DEFAULT === $experimental_data['state'] ) {
995 - $experimental_data['default'] = self::STATE_INACTIVE;
996 - }
997 -
998 - return $experimental_data;
999 - }
1000 -
1001 - /**
1002 - * @param array $new_site
1003 - * @param array $experimental_data
1004 - * @return array
1005 - */
1006 - private function set_new_site_default_state( $new_site, array $experimental_data ): array {
1007 - if ( ! $this->install_compare( $new_site['minimum_installation_version'] ) ) {
1008 - return $experimental_data;
1009 - }
1010 -
1011 - if ( $new_site['always_active'] ) {
1012 - $experimental_data['state'] = self::STATE_ACTIVE;
1013 - $experimental_data['mutable'] = false;
1014 - } elseif ( $new_site['default_active'] ) {
1015 - $experimental_data['default'] = self::STATE_ACTIVE;
1016 - } elseif ( $new_site['default_inactive'] ) {
1017 - $experimental_data['default'] = self::STATE_INACTIVE;
1018 - }
1019 -
1020 - return $experimental_data;
1021 - }
1022 -
1023 - /**
1024 - * @param array $options
1025 - * @return array
1026 - */
1027 - private function set_feature_initial_options( array $options ): array {
1028 - $default_experimental_data = [
1029 - 'tag' => '', // Deprecated, use 'tags' instead.
1030 - 'tags' => [],
1031 - 'description' => '',
1032 - 'release_status' => self::RELEASE_STATUS_ALPHA,
1033 - 'default' => self::STATE_INACTIVE,
1034 - 'mutable' => true,
1035 - static::TYPE_HIDDEN => false,
1036 - 'new_site' => [
1037 - 'always_active' => false,
1038 - 'default_active' => false,
1039 - 'default_inactive' => false,
1040 - 'minimum_installation_version' => null,
1041 - ],
1042 - 'on_state_change' => null,
1043 - 'generator_tag' => false,
1044 - 'deprecated' => false,
1045 - ];
1046 -
1047 - $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages', 'deprecated' ];
1048 - $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
1049 -
1050 - return $this->unify_feature_tags( $experimental_data );
1051 1011 }
1052 1012 }