PluginProbe
Elementor Website Builder – more than just a page builder / 3.25.4
Elementor Website Builder – more than just a page builder v3.25.4
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 4.1.0-beta2 4.1.0-dev2 4.0.8 4.1.0-beta1 4.1.0-dev1 All 452 releases
← All changes | core/experiments/manager.php +164 -188 4.3.0-beta23.25.4 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,48 @@
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 + 'always_active' => false,
80 + 'default_active' => false,
81 + 'default_inactive' => false,
82 + 'minimum_installation_version' => null,
83 + ],
84 + 'on_state_change' => null,
85 + 'generator_tag' => false,
86 + ];
72 87
88 + $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages' ];
89 +
90 + $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
91 +
92 + $experimental_data = $this->unify_feature_tags( $experimental_data );
93 +
73 94 $new_site = $experimental_data['new_site'];
74 95
75 96 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 );
97 + $is_new_installation = $this->install_compare( $new_site['minimum_installation_version'] );
98 +
99 + if ( $is_new_installation ) {
100 + if ( $new_site['always_active'] ) {
101 + $experimental_data['state'] = self::STATE_ACTIVE;
102 +
103 + $experimental_data['mutable'] = false;
104 + } elseif ( $new_site['default_active'] ) {
105 + $experimental_data['default'] = self::STATE_ACTIVE;
106 + } elseif ( $new_site['default_inactive'] ) {
107 + $experimental_data['default'] = self::STATE_INACTIVE;
108 + }
109 + }
77 110 }
78 111
79 112 if ( $experimental_data['mutable'] ) {
80 113 $experimental_data['state'] = $this->get_saved_feature_state( $options['name'] );
@@ -84,9 +117,17 @@
84 117 $experimental_data['state'] = self::STATE_DEFAULT;
85 118 }
86 119
87 120 if ( ! empty( $experimental_data['dependencies'] ) ) {
88 - $experimental_data = $this->initialize_feature_dependencies( $experimental_data );
121 + foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
122 + $feature = $this->get_features( $dependency );
123 +
124 + if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
125 + throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
126 + }
127 +
128 + $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
129 + }
89 130 }
90 131
91 132 $this->features[ $options['name'] ] = $experimental_data;
92 133
@@ -120,11 +161,9 @@
120 161 private function install_compare( $version ) {
121 162 $installs_history = Upgrade_Manager::get_installs_history();
122 163
123 164 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, '>=' );
165 + return false;
127 166 }
128 167
129 168 $cleaned_version = preg_replace( '/-(beta|cloud|dev)\d*$/', '', key( $installs_history ) );
130 169
@@ -141,9 +180,9 @@
141 180 * @param array $experimental_data
142 181 *
143 182 * @return array
144 183 */
145 - private function unify_feature_tags( array $experimental_data ): array {
184 + private function unify_feature_tags( array $experimental_data ) : array {
146 185 foreach ( [ 'tag', 'tags' ] as $key ) {
147 186 if ( empty( $experimental_data[ $key ] ) ) {
148 187 continue;
149 188 }
@@ -160,21 +199,18 @@
160 199
161 200 /**
162 201 * Format feature tags into the right format.
163 202 *
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 - * ]
203 + * @param string|array[
204 + * [
205 + * 'type' => string,
206 + * 'label' => string
207 + * ]
208 + * ] $tag
171 209 *
172 - * @param string|array $tags A string of comma separated tags, or an array of tags.
173 - *
174 210 * @return array
175 211 */
176 - private function format_feature_tags( $tags ): array {
212 + private function format_feature_tags( $tags ) : array {
177 213 if ( ! is_string( $tags ) && ! is_array( $tags ) ) {
178 214 return [];
179 215 }
180 216
@@ -223,9 +259,9 @@
223 259 *
224 260 * @since 3.1.0
225 261 * @access public
226 262 *
227 - * @param string $feature_name Optional. Default is null.
263 + * @param string $feature_name Optional. Default is null
228 264 *
229 265 * @return array|null
230 266 */
231 267 public function get_features( $feature_name = null ) {
@@ -253,27 +289,16 @@
253 289 * @param string $feature_name
254 290 *
255 291 * @return bool
256 292 */
257 - public function is_feature_active( $feature_name, $check_dependencies = false ) {
293 + public function is_feature_active( $feature_name ) {
258 294 $feature = $this->get_features( $feature_name );
259 295
260 - if ( ! $feature || self::STATE_ACTIVE !== $this->get_feature_actual_state( $feature ) ) {
296 + if ( ! $feature ) {
261 297 return false;
262 298 }
263 299
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;
300 + return self::STATE_ACTIVE === $this->get_feature_actual_state( $feature );
276 301 }
277 302
278 303 /**
279 304 * Set Feature Default State
@@ -309,8 +334,24 @@
309 334 }
310 335
311 336 private function add_default_features() {
312 337 $this->add_feature( [
338 + 'name' => 'e_optimized_css_loading',
339 + 'title' => esc_html__( 'Improved CSS Loading', 'elementor' ),
340 + 'tag' => esc_html__( 'Performance', 'elementor' ),
341 + 'description' => sprintf(
342 + '%1$s <a href="https://go.elementor.com/wp-dash-improved-css-loading/" target="_blank">%2$s</a>',
343 + 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' ),
344 + esc_html__( 'Learn more', 'elementor' )
345 + ),
346 + 'release_status' => self::RELEASE_STATUS_STABLE,
347 + 'default' => self::STATE_INACTIVE,
348 + static::TYPE_HIDDEN => true,
349 + 'mutable' => false,
350 + 'generator_tag' => true,
351 + ] );
352 +
353 + $this->add_feature( [
313 354 'name' => 'e_font_icon_svg',
314 355 'title' => esc_html__( 'Inline Font Icons', 'elementor' ),
315 356 'tag' => esc_html__( 'Performance', 'elementor' ),
316 357 'description' => sprintf(
@@ -342,13 +383,14 @@
342 383 $this->add_feature( [
343 384 'name' => 'container',
344 385 'title' => esc_html__( 'Container', 'elementor' ),
345 386 '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' ),
387 + 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 388 '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container/">',
349 389 '</a>',
350 390 '<a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">',
391 + '</a>',
392 + '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container-playground/">',
351 393 '</a>'
352 394 ),
353 395 'release_status' => self::RELEASE_STATUS_STABLE,
354 396 'default' => self::STATE_INACTIVE,
@@ -365,28 +407,71 @@
365 407 ],
366 408 ] );
367 409
368 410 $this->add_feature( [
411 + 'name' => 'e_swiper_latest',
412 + 'title' => esc_html__( 'Upgrade Swiper Library', 'elementor' ),
413 + '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' ),
414 + 'release_status' => self::RELEASE_STATUS_STABLE,
415 + 'default' => self::STATE_ACTIVE,
416 + ] );
417 +
418 + $this->add_feature( [
419 + 'name' => 'e_nested_atomic_repeaters',
420 + 'title' => esc_html__( 'Nested Elements Performance', 'elementor' ),
421 + 'tag' => esc_html__( 'Performance', 'elementor' ),
422 + 'description' => esc_html__( 'Improve the performance of the Nested widgets.', 'elementor' ),
423 + static::TYPE_HIDDEN => true,
424 + 'release_status' => self::RELEASE_STATUS_DEV,
425 + 'default' => self::STATE_ACTIVE,
426 + ] );
427 +
428 + $this->add_feature( [
429 + 'name' => 'e_optimized_control_loading',
430 + 'title' => esc_html__( 'Optimized Control Loading', 'elementor' ),
431 + 'tag' => esc_html__( 'Performance', 'elementor' ),
432 + 'description' => esc_html__( 'Use this experiment to improve control loading. This experiment improves site performance by loading controls only when needed.', 'elementor' ),
433 + 'release_status' => self::RELEASE_STATUS_STABLE,
434 + 'default' => self::STATE_ACTIVE,
435 + 'generator_tag' => true,
436 + ] );
437 +
438 + $this->add_feature( [
369 439 'name' => 'e_optimized_markup',
370 440 'title' => esc_html__( 'Optimized Markup', 'elementor' ),
371 441 'tag' => esc_html__( 'Performance', 'elementor' ),
372 442 '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' ),
373 - 'release_status' => self::RELEASE_STATUS_STABLE,
443 + 'release_status' => self::RELEASE_STATUS_ALPHA,
374 444 'default' => self::STATE_INACTIVE,
375 - 'new_site' => [
376 - 'default_active' => true,
377 - 'minimum_installation_version' => '3.30.0',
378 - ],
379 445 ] );
380 446
381 447 $this->add_feature( [
382 - 'name' => 'e_optimized_css_files',
383 - 'title' => esc_html__( 'Optimized CSS Files', 'elementor' ),
448 + 'name' => 'e_swiper_css_conditional_loading',
449 + 'title' => esc_html__( 'Conditionally load Swiper CSS files', 'elementor' ),
450 + static::TYPE_HIDDEN => true,
451 + 'default' => self::STATE_INACTIVE,
452 + ] );
453 +
454 + $this->add_feature( [
455 + 'name' => 'e_onboarding',
456 + 'title' => esc_html__( 'Plugin Onboarding', 'elementor' ),
457 + 'description' => esc_html__( 'New plugin onboarding.', 'elementor' ),
458 + static::TYPE_HIDDEN => true,
459 + 'release_status' => self::RELEASE_STATUS_ALPHA,
460 + 'default' => self::STATE_ACTIVE,
461 + ] );
462 +
463 + // TODO: Possibly remove experiment in v3.27.0 [ED-15717].
464 + // Check this reference in Pro: 'sticky_anchor_link_offset'.
465 + $this->add_feature( [
466 + 'name' => 'e_css_smooth_scroll',
467 + 'title' => esc_html__( 'CSS Smooth Scroll', 'elementor' ),
384 468 'tag' => esc_html__( 'Performance', 'elementor' ),
385 - 'description' => esc_html__( 'Keeps external CSS files available and consistent for sites behind page caching or a CDN.', 'elementor' ),
386 - 'release_status' => self::RELEASE_STATUS_ALPHA,
387 - 'default' => self::STATE_INACTIVE,
388 - 'generator_tag' => true,
469 + 'description' => esc_html__( 'Use CSS Smooth Scroll to improve the user experience on your site. This experiment replaces the default JavaScript-based smooth scroll with a CSS-based solution.', 'elementor' ),
470 + 'release_status' => self::RELEASE_STATUS_DEV,
471 + static::TYPE_HIDDEN => true,
472 + 'default' => self::STATE_ACTIVE,
473 + 'mutable' => false,
389 474 ] );
390 475 }
391 476
392 477 /**
@@ -413,8 +498,9 @@
413 498 $this->release_statuses = [
414 499 self::RELEASE_STATUS_DEV => esc_html__( 'Development', 'elementor' ),
415 500 self::RELEASE_STATUS_ALPHA => esc_html__( 'Alpha', 'elementor' ),
416 501 self::RELEASE_STATUS_BETA => esc_html__( 'Beta', 'elementor' ),
502 + self::RELEASE_STATUS_RC => esc_html__( 'Release Candidate', 'elementor' ),
417 503 self::RELEASE_STATUS_STABLE => esc_html__( 'Stable', 'elementor' ),
418 504 ];
419 505 }
420 506
@@ -438,8 +524,9 @@
438 524 * @param Settings $settings
439 525 *
440 526 * @since 3.1.0
441 527 * @access private
528 + *
442 529 */
443 530 private function register_settings_fields( Settings $settings ) {
444 531 $features = $this->get_features();
445 532
@@ -527,9 +614,9 @@
527 614 <?php echo esc_html__( 'Experiments and Features', 'elementor' ); ?>
528 615 </h2>
529 616 <p class="e-experiment__description">
530 617 <?php
531 - printf(
618 + echo sprintf(
532 619 /* translators: %1$s Link open tag, %2$s: Link close tag. */
533 620 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' ),
534 621 '<a href="https://go.elementor.com/wp-dash-experiments-report-an-issue/" target="_blank">',
535 622 '</a>'
@@ -537,9 +624,9 @@
537 624 ?>
538 625 </p>
539 626 <p class="e-experiment__description">
540 627 <?php
541 - printf(
628 + echo sprintf(
542 629 '%1$s <a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">%2$s</a>',
543 630 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' ),
544 631 esc_html__( 'Learn more', 'elementor' ),
545 632 );
@@ -631,13 +718,13 @@
631 718 ->find( function ( $dependency ) {
632 719 return $dependency instanceof Non_Existing_Dependency;
633 720 } );
634 721
635 - return (bool) $non_existing_dep;
722 + return ! ! $non_existing_dep;
636 723 }
637 724
638 725 /**
639 - * Get Feature Settings Label HTML.
726 + * Get Feature Settings Label HTML
640 727 *
641 728 * @since 3.1.0
642 729 * @access private
643 730 *
@@ -662,16 +749,10 @@
662 749 <div class="e-experiment__title">
663 750 <div class="<?php echo $indicator_classes; ?>" data-tooltip="<?php echo $indicator_tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"></div>
664 751 <label class="e-experiment__title__label" for="e-experiment-<?php echo $feature['name']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"><?php echo $feature['title']; ?></label>
665 752 <?php foreach ( $feature['tags'] as $tag ) { ?>
666 - <?php
667 - $tag_classes = 'e-experiment__title__tag e-experiment__title__tag__' . $tag['type'] . ' e-editor-one';
668 - ?>
669 - <span class="<?php echo esc_attr( $tag_classes ); ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span>
753 + <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>
670 754 <?php } ?>
671 - <?php if ( $feature['deprecated'] ) { ?>
672 - <span class="e-experiment__title__tag e-experiment__title__tag__deprecated"><?php echo esc_html__( 'Deprecated', 'elementor' ); ?></span>
673 - <?php } ?>
674 755 </div>
675 756 <?php
676 757
677 758 return ob_get_clean();
@@ -735,11 +816,12 @@
735 816 *
736 817 * @since 3.1.0
737 818 * @access private
738 819 *
739 - * @param array $old_feature_data
820 + * @param array $old_feature_data
740 821 * @param string $new_state
741 - * @param string $old_state
822 + *
823 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
742 824 */
743 825 private function on_feature_state_change( array $old_feature_data, $new_state, $old_state ) {
744 826 $new_feature_data = $this->get_features( $old_feature_data['name'] );
745 827 $this->validate_dependency( $new_feature_data, $new_state );
@@ -756,9 +838,9 @@
756 838 do_action( 'elementor/experiments/feature-state-change/' . $old_feature_data['name'], $old_state, $new_state );
757 839 }
758 840
759 841 /**
760 - * @throws Exceptions\Dependency_Exception If the feature dependency is not available or not active.
842 + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception
761 843 */
762 844 private function validate_dependency( array $feature, $new_state ) {
763 845 $rollback = function ( $feature_option_key, $state ) {
764 846 remove_all_actions( 'add_option_' . $feature_option_key );
@@ -787,10 +869,10 @@
787 869
788 870 throw new Exceptions\Dependency_Exception(
789 871 sprintf(
790 872 'The feature `%s` has a dependency `%s` that is not available.',
791 - esc_html( $feature['name'] ),
792 - esc_html( $dependency->get_name() )
873 + $feature['name'],
874 + $dependency->get_name()
793 875 )
794 876 );
795 877 }
796 878
@@ -802,10 +884,10 @@
802 884
803 885 throw new Exceptions\Dependency_Exception(
804 886 sprintf(
805 887 'To turn on `%1$s`, Experiment: `%2$s` activity is required!',
806 - esc_html( $feature['name'] ),
807 - esc_html( $dependency_feature['name'] )
888 + $feature['name'],
889 + $dependency_feature['name']
808 890 )
809 891 );
810 892 }
811 893 }
@@ -850,9 +932,11 @@
850 932 * This behavior interferes with the experiments dependency mechanism because the data that's being sent can be in any order,
851 933 * while the dependencies mechanism expects it to be in a specific order (dependencies should be activated before their dependents can).
852 934 * In order to solve this issue, we sort the experiments in the POST data based on their dependencies tree.
853 935 *
854 - * @param array $allowed_options
936 + * @param $allowed_options
937 + *
938 + * @return mixed
855 939 */
856 940 private function sort_allowed_options_by_dependencies( $allowed_options ) {
857 941 if ( ! isset( $allowed_options['elementor'] ) ) {
858 942 return $allowed_options;
@@ -940,114 +1024,6 @@
940 1024 // Register CLI commands.
941 1025 if ( Utils::is_wp_cli() ) {
942 1026 \WP_CLI::add_command( 'elementor experiments', WP_CLI::class );
943 1027 }
944 - }
945 -
946 - /**
947 - * @param array $experimental_data
948 - * @return array
949 - *
950 - * @throws Exceptions\Dependency_Exception If the feature dependency is not initialized or depends on a hidden experiment.
951 - */
952 - private function initialize_feature_dependencies( array $experimental_data ): array {
953 - foreach ( $experimental_data['dependencies'] as $key => $dependency ) {
954 - $feature = $this->get_features( $dependency );
955 -
956 - if ( ! isset( $feature ) ) {
957 - // since we must validate the state of each dependency, we have to make sure that dependencies are initialized in the correct order, otherwise, error.
958 - throw new Exceptions\Dependency_Exception(
959 - sprintf(
960 - 'Feature %s cannot be initialized before dependency feature: %s.',
961 - esc_html( $experimental_data['name'] ),
962 - esc_html( $dependency )
963 - )
964 - );
965 - }
966 -
967 - if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) {
968 - throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' );
969 - }
970 -
971 - $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature );
972 - $experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data );
973 - }
974 -
975 - return $experimental_data;
976 - }
977 -
978 - /**
979 - * @param array $feature
980 - * @param array $experimental_data
981 - * @return array
982 - *
983 - * we must validate the state:
984 - * * A user can set a dependant feature to inactive and in upgrade we don't change users settings.
985 - * * A developer can set the default state to be invalid (e.g. dependant feature is inactive).
986 - * if one of the dependencies is inactive, the main feature should be inactive as well.
987 - */
988 - private function set_feature_default_state_to_match_dependencies( array $feature, array $experimental_data ): array {
989 - if ( self::STATE_INACTIVE !== $this->get_feature_actual_state( $feature ) ) {
990 - return $experimental_data;
991 - }
992 -
993 - if ( self::STATE_ACTIVE === $experimental_data['state'] ) {
994 - $experimental_data['state'] = self::STATE_INACTIVE;
995 - } elseif ( self::STATE_DEFAULT === $experimental_data['state'] ) {
996 - $experimental_data['default'] = self::STATE_INACTIVE;
997 - }
998 -
999 - return $experimental_data;
1000 - }
1001 -
1002 - /**
1003 - * @param array $new_site
1004 - * @param array $experimental_data
1005 - * @return array
1006 - */
1007 - private function set_new_site_default_state( $new_site, array $experimental_data ): array {
1008 - if ( ! $this->install_compare( $new_site['minimum_installation_version'] ) ) {
1009 - return $experimental_data;
1010 - }
1011 -
1012 - if ( $new_site['always_active'] ) {
1013 - $experimental_data['state'] = self::STATE_ACTIVE;
1014 - $experimental_data['mutable'] = false;
1015 - } elseif ( $new_site['default_active'] ) {
1016 - $experimental_data['default'] = self::STATE_ACTIVE;
1017 - } elseif ( $new_site['default_inactive'] ) {
1018 - $experimental_data['default'] = self::STATE_INACTIVE;
1019 - }
1020 -
1021 - return $experimental_data;
1022 - }
1023 -
1024 - /**
1025 - * @param array $options
1026 - * @return array
1027 - */
1028 - private function set_feature_initial_options( array $options ): array {
1029 - $default_experimental_data = [
1030 - 'tag' => '', // Deprecated, use 'tags' instead.
1031 - 'tags' => [],
1032 - 'description' => '',
1033 - 'release_status' => self::RELEASE_STATUS_ALPHA,
1034 - 'default' => self::STATE_INACTIVE,
1035 - 'mutable' => true,
1036 - static::TYPE_HIDDEN => false,
1037 - 'new_site' => [
1038 - 'always_active' => false,
1039 - 'default_active' => false,
1040 - 'default_inactive' => false,
1041 - 'minimum_installation_version' => null,
1042 - ],
1043 - 'on_state_change' => null,
1044 - 'generator_tag' => false,
1045 - 'deprecated' => false,
1046 - ];
1047 -
1048 - $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages', 'deprecated' ];
1049 - $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options );
1050 -
1051 - return $this->unify_feature_tags( $experimental_data );
1052 1028 }
1053 1029 }