features[ $options['name'] ] ) ) { return null; } $experimental_data = $this->set_feature_initial_options( $options ); $new_site = $experimental_data['new_site']; if ( $new_site['default_active'] || $new_site['always_active'] || $new_site['default_inactive'] ) { $experimental_data = $this->set_new_site_default_state( $new_site, $experimental_data ); } if ( $experimental_data['mutable'] ) { $experimental_data['state'] = $this->get_saved_feature_state( $options['name'] ); } if ( empty( $experimental_data['state'] ) ) { $experimental_data['state'] = self::STATE_DEFAULT; } if ( ! empty( $experimental_data['dependencies'] ) ) { $experimental_data = $this->initialize_feature_dependencies( $experimental_data ); } $this->features[ $options['name'] ] = $experimental_data; if ( $experimental_data['mutable'] && is_admin() ) { $feature_option_key = $this->get_feature_option_key( $options['name'] ); $on_state_change_callback = function( $old_state, $new_state ) use ( $experimental_data, $feature_option_key ) { try { $this->on_feature_state_change( $experimental_data, $new_state, $old_state ); } catch ( Exceptions\Dependency_Exception $e ) { $message = sprintf( '

%s

%s

', esc_html( $e->getMessage() ), Settings::get_settings_tab_url( 'experiments' ), esc_html__( 'Back', 'elementor' ) ); wp_die( $message ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped } }; add_action( 'add_option_' . $feature_option_key, $on_state_change_callback, 10, 2 ); add_action( 'update_option_' . $feature_option_key, $on_state_change_callback, 10, 2 ); } do_action( 'elementor/experiments/feature-registered', $this, $experimental_data ); return $experimental_data; } private function install_compare( $version ) { $installs_history = Upgrade_Manager::get_installs_history(); if ( empty( $installs_history ) ) { return false; } $cleaned_version = preg_replace( '/-(beta|cloud|dev)\d*$/', '', key( $installs_history ) ); return version_compare( $cleaned_version, $version, '>=' ); } /** * Combine 'tag' and 'tags' into one property. * * @param array $experimental_data * * @return array */ private function unify_feature_tags( array $experimental_data ) : array { foreach ( [ 'tag', 'tags' ] as $key ) { if ( empty( $experimental_data[ $key ] ) ) { continue; } $experimental_data[ $key ] = $this->format_feature_tags( $experimental_data[ $key ] ); } if ( is_array( $experimental_data['tag'] ) ) { $experimental_data['tags'] = array_merge( $experimental_data['tag'], $experimental_data['tags'] ); } return $experimental_data; } /** * Format feature tags into the right format. * * @param string|array[ * [ * 'type' => string, * 'label' => string * ] * ] $tag * * @return array */ private function format_feature_tags( $tags ) : array { if ( ! is_string( $tags ) && ! is_array( $tags ) ) { return []; } $default_tag = [ 'type' => 'default', 'label' => '', ]; $allowed_tag_properties = [ 'type', 'label' ]; // If $tags is string, explode by commas and convert to array. if ( is_string( $tags ) ) { $tags = array_filter( explode( ',', $tags ) ); foreach ( $tags as $i => $tag ) { $tags[ $i ] = [ 'label' => trim( $tag ) ]; } } foreach ( $tags as $i => $tag ) { if ( empty( $tag['label'] ) ) { unset( $tags[ $i ] ); continue; } $tags[ $i ] = $this->merge_properties( $default_tag, $tag, $allowed_tag_properties ); } return $tags; } /** * Remove Feature * * @since 3.1.0 * @access public * * @param string $feature_name */ public function remove_feature( $feature_name ) { unset( $this->features[ $feature_name ] ); } /** * Get Features * * @since 3.1.0 * @access public * * @param string $feature_name Optional. Default is null * * @return array|null */ public function get_features( $feature_name = null ) { return self::get_items( $this->features, $feature_name ); } /** * Get Active Features * * @since 3.1.0 * @access public * * @return array */ public function get_active_features() { return array_filter( $this->features, [ $this, 'is_feature_active' ], ARRAY_FILTER_USE_KEY ); } /** * Is Feature Active * * @since 3.1.0 * @access public * * @param string $feature_name * * @return bool */ public function is_feature_active( $feature_name, $check_dependencies = false ) { $feature = $this->get_features( $feature_name ); if ( ! $feature || self::STATE_ACTIVE !== $this->get_feature_actual_state( $feature ) ) { return false; } if ( $check_dependencies && isset( $feature['dependencies'] ) && is_array( $feature['dependencies'] ) ) { foreach ( $feature['dependencies'] as $dependency ) { $dependent_feature = $this->get_features( $dependency->get_name() ); $feature_state = self::STATE_ACTIVE === $this->get_feature_actual_state( $dependent_feature ); if ( ! $feature_state ) { return false; } } } return true; } /** * Set Feature Default State * * @since 3.1.0 * @access public * * @param string $feature_name * @param string $default_state */ public function set_feature_default_state( $feature_name, $default_state ) { $feature = $this->get_features( $feature_name ); if ( ! $feature ) { return; } $this->features[ $feature_name ]['default'] = $default_state; } /** * Get Feature Option Key * * @since 3.1.0 * @access public * * @param string $feature_name * * @return string */ public function get_feature_option_key( $feature_name ) { return static::OPTION_PREFIX . $feature_name; } private function add_default_features() { $this->add_feature( [ 'name' => 'e_font_icon_svg', 'title' => esc_html__( 'Inline Font Icons', 'elementor' ), 'tag' => esc_html__( 'Performance', 'elementor' ), 'description' => sprintf( '%1$s %2$s', 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' ), esc_html__( 'Learn more', 'elementor' ) ), 'release_status' => self::RELEASE_STATUS_STABLE, 'new_site' => [ 'default_active' => true, 'minimum_installation_version' => '3.17.0', ], 'generator_tag' => true, ] ); $this->add_feature( [ 'name' => 'additional_custom_breakpoints', 'title' => esc_html__( 'Additional Custom Breakpoints', 'elementor' ), 'description' => sprintf( '%1$s %2$s', 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' ), esc_html__( 'Learn more', 'elementor' ) ), 'release_status' => self::RELEASE_STATUS_STABLE, 'default' => self::STATE_ACTIVE, 'generator_tag' => true, ] ); $this->add_feature( [ 'name' => 'container', 'title' => esc_html__( 'Container', 'elementor' ), 'description' => sprintf( 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' ), '', '', '', '', '', '' ), 'release_status' => self::RELEASE_STATUS_STABLE, 'default' => self::STATE_INACTIVE, 'new_site' => [ 'default_active' => true, 'minimum_installation_version' => '3.16.0', ], 'messages' => [ 'on_deactivate' => sprintf( '%1$s %2$s', esc_html__( 'Container-based content will be hidden from your site and may not be recoverable in all cases.', 'elementor' ), esc_html__( 'Learn more', 'elementor' ), ), ], ] ); // TODO: Remove this experiment in v3.28 [ED-15983]. $this->add_feature( [ 'name' => 'e_swiper_latest', 'title' => esc_html__( 'Upgrade Swiper Library', 'elementor' ), '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' ), 'default' => self::STATE_ACTIVE, static::TYPE_HIDDEN => true, 'mutable' => false, ] ); $this->add_feature( [ 'name' => 'e_optimized_markup', 'title' => esc_html__( 'Optimized Markup', 'elementor' ), 'tag' => esc_html__( 'Performance', 'elementor' ), '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' ), 'release_status' => self::RELEASE_STATUS_ALPHA, 'default' => self::STATE_INACTIVE, ] ); $this->add_feature( [ 'name' => 'e_onboarding', 'title' => esc_html__( 'Plugin Onboarding', 'elementor' ), 'description' => esc_html__( 'New plugin onboarding.', 'elementor' ), static::TYPE_HIDDEN => true, 'release_status' => self::RELEASE_STATUS_ALPHA, 'default' => self::STATE_ACTIVE, ] ); $this->add_feature( [ 'name' => 'e_local_google_fonts', 'title' => esc_html__( 'Load Google Fonts locally', 'elementor' ), 'description' => esc_html__( "To improve page load performance and user privacy, replace Google Fonts CDN links with self-hosted font files. This approach downloads and serves font files directly from your server, eliminating external requests to Google's servers.", 'elementor' ), 'tag' => esc_html__( 'Performance', 'elementor' ), 'release_status' => self::RELEASE_STATUS_BETA, 'generator_tag' => true, 'default' => self::STATE_INACTIVE, ] ); } /** * Init States * * @since 3.1.0 * @access private */ private function init_states() { $this->states = [ self::STATE_DEFAULT => esc_html__( 'Default', 'elementor' ), self::STATE_ACTIVE => esc_html__( 'Active', 'elementor' ), self::STATE_INACTIVE => esc_html__( 'Inactive', 'elementor' ), ]; } /** * Init Statuses * * @since 3.1.0 * @access private */ private function init_release_statuses() { $this->release_statuses = [ self::RELEASE_STATUS_DEV => esc_html__( 'Development', 'elementor' ), self::RELEASE_STATUS_ALPHA => esc_html__( 'Alpha', 'elementor' ), self::RELEASE_STATUS_BETA => esc_html__( 'Beta', 'elementor' ), self::RELEASE_STATUS_RC => esc_html__( 'Release Candidate', 'elementor' ), self::RELEASE_STATUS_STABLE => esc_html__( 'Stable', 'elementor' ), ]; } /** * Init Features * * @since 3.1.0 * @access private */ private function init_features() { $this->features = []; $this->add_default_features(); do_action( 'elementor/experiments/default-features-registered', $this ); } /** * Register Settings Fields * * @param Settings $settings * * @since 3.1.0 * @access private * */ private function register_settings_fields( Settings $settings ) { $features = $this->get_features(); $fields = []; foreach ( $features as $feature_name => $feature ) { $is_hidden = $feature[ static::TYPE_HIDDEN ]; $is_mutable = $feature['mutable']; $should_hide_experiment = ! $is_mutable || ( $is_hidden && ! $this->should_show_hidden() ) || $this->has_non_existing_dependency( $feature ); if ( $should_hide_experiment ) { unset( $features[ $feature_name ] ); continue; } $feature_key = 'experiment-' . $feature_name; $section = 'stable' === $feature['release_status'] ? 'stable' : 'ongoing'; $fields[ $section ][ $feature_key ]['label'] = $this->get_feature_settings_label_html( $feature ); $fields[ $section ][ $feature_key ]['field_args'] = $feature; $fields[ $section ][ $feature_key ]['render'] = function( $feature ) { $this->render_feature_settings_field( $feature ); }; } foreach ( [ 'stable', 'ongoing' ] as $section ) { if ( ! isset( $fields[ $section ] ) ) { $fields[ $section ]['no_features'] = [ 'label' => esc_html__( 'No available experiments', 'elementor' ), 'field_args' => [ 'type' => 'raw_html', 'html' => esc_html__( 'The current version of Elementor doesn\'t have any experimental features . if you\'re feeling curious make sure to come back in future versions.', 'elementor' ), ], ]; } if ( ! Tracker::is_allow_track() && 'stable' === $section ) { $fields[ $section ] += $settings->get_usage_fields(); } } $settings->add_tab( 'experiments', [ 'label' => esc_html__( 'Features', 'elementor' ), 'sections' => [ 'ongoing_experiments' => [ 'callback' => function() { $this->render_settings_intro(); }, 'fields' => $fields['ongoing'], ], 'stable_experiments' => [ 'callback' => function() { $this->render_stable_section_title(); }, 'fields' => $fields['stable'], ], ], ] ); } private function render_stable_section_title() { ?>

', '' ); ?>

%2$s', 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' ), esc_html__( 'Learn more', 'elementor' ), ); ?>

get_features() ) { ?>

get_feature_option_key( $feature['name'] ); $status = sprintf( /* translators: %s Release status. */ esc_html__( 'Status: %s', 'elementor' ), $this->release_statuses[ $feature['release_status'] ] ); ?>

render_feature_dependency( $feature ); ?>
map( function ( $dependency ) { return $dependency->get_title(); } ) ->implode( ', ' ); if ( empty( $dependencies ) ) { return; } ?>
:
find( function ( $dependency ) { return $dependency instanceof Non_Existing_Dependency; } ); return ! ! $non_existing_dep; } /** * Get Feature Settings Label HTML * * @since 3.1.0 * @access private * * @param array $feature * * @return string */ private function get_feature_settings_label_html( array $feature ) { ob_start(); $is_feature_active = $this->is_feature_active( $feature['name'] ); $indicator_classes = 'e-experiment__title__indicator'; if ( $is_feature_active ) { $indicator_classes .= ' e-experiment__title__indicator--active'; } $indicator_tooltip = $this->get_feature_state_label( $feature ); ?>
is_feature_active( $feature['name'] ); if ( self::STATE_DEFAULT === $feature['state'] ) { $label = $is_feature_active ? esc_html__( 'Active by default', 'elementor' ) : esc_html__( 'Inactive by default', 'elementor' ); } else { $label = self::STATE_ACTIVE === $feature['state'] ? esc_html__( 'Active', 'elementor' ) : esc_html__( 'Inactive', 'elementor' ); } return $label; } /** * Get Feature Settings Label HTML * * @since 3.1.0 * @access private * * @param string $feature_name * * @return int */ private function get_saved_feature_state( $feature_name ) { return get_option( $this->get_feature_option_key( $feature_name ) ); } /** * Get Feature Actual State * * @since 3.1.0 * @access private * * @param array $feature * * @return string */ private function get_feature_actual_state( array $feature ) { if ( ! empty( $feature['state'] ) && self::STATE_DEFAULT !== $feature['state'] ) { return $feature['state']; } return $feature['default']; } /** * On Feature State Change * * @since 3.1.0 * @access private * * @param array $old_feature_data * @param string $new_state * * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception */ private function on_feature_state_change( array $old_feature_data, $new_state, $old_state ) { $new_feature_data = $this->get_features( $old_feature_data['name'] ); $this->validate_dependency( $new_feature_data, $new_state ); $this->features[ $old_feature_data['name'] ]['state'] = $new_state; if ( $old_state === $new_state ) { return; } Plugin::$instance->files_manager->clear_cache(); if ( $new_feature_data['on_state_change'] ) { $new_feature_data['on_state_change']( $old_state, $new_state ); } do_action( 'elementor/experiments/feature-state-change/' . $old_feature_data['name'], $old_state, $new_state ); } /** * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception */ private function validate_dependency( array $feature, $new_state ) { $rollback = function ( $feature_option_key, $state ) { remove_all_actions( 'add_option_' . $feature_option_key ); remove_all_actions( 'update_option_' . $feature_option_key ); update_option( $feature_option_key, $state ); }; if ( self::STATE_DEFAULT === $new_state ) { $new_state = $this->get_feature_actual_state( $feature ); } $feature_option_key = $this->get_feature_option_key( $feature['name'] ); if ( self::STATE_ACTIVE === $new_state ) { if ( empty( $feature['dependencies'] ) ) { return; } // Validate if the current feature dependency is available. foreach ( $feature['dependencies'] as $dependency ) { $dependency_feature = $this->get_features( $dependency->get_name() ); if ( ! $dependency_feature ) { $rollback( $feature_option_key, self::STATE_INACTIVE ); throw new Exceptions\Dependency_Exception( sprintf( 'The feature `%s` has a dependency `%s` that is not available.', $feature['name'], $dependency->get_name() ) ); } $dependency_state = $this->get_feature_actual_state( $dependency_feature ); // If dependency is not active. if ( self::STATE_INACTIVE === $dependency_state ) { $rollback( $feature_option_key, self::STATE_INACTIVE ); throw new Exceptions\Dependency_Exception( sprintf( 'To turn on `%1$s`, Experiment: `%2$s` activity is required!', $feature['name'], $dependency_feature['name'] ) ); } } } elseif ( self::STATE_INACTIVE === $new_state ) { // Make sure to deactivate a dependant experiment of the current feature when it's deactivated. foreach ( $this->get_features() as $current_feature ) { if ( empty( $current_feature['dependencies'] ) ) { continue; } $current_feature_state = $this->get_feature_actual_state( $current_feature ); foreach ( $current_feature['dependencies'] as $dependency ) { if ( self::STATE_ACTIVE === $current_feature_state && $feature['name'] === $dependency->get_name() ) { update_option( $this->get_feature_option_key( $current_feature['name'] ), static::STATE_INACTIVE ); } } } } } private function should_show_hidden() { return defined( 'ELEMENTOR_SHOW_HIDDEN_EXPERIMENTS' ) && ELEMENTOR_SHOW_HIDDEN_EXPERIMENTS; } private function create_dependency_class( $dependency_name, $dependency_args ) { if ( class_exists( $dependency_name ) ) { return $dependency_name::instance(); } if ( ! empty( $dependency_args ) ) { return new Wrap_Core_Dependency( $dependency_args ); } return new Non_Existing_Dependency( $dependency_name ); } /** * The experiments page is a WordPress options page, which means all the experiments are registered via WordPress' register_settings(), * and their states are being sent in the POST request when saving. * The options are being updated in a chronological order based on the POST data. * This behavior interferes with the experiments dependency mechanism because the data that's being sent can be in any order, * while the dependencies mechanism expects it to be in a specific order (dependencies should be activated before their dependents can). * In order to solve this issue, we sort the experiments in the POST data based on their dependencies tree. * * @param $allowed_options * * @return mixed */ private function sort_allowed_options_by_dependencies( $allowed_options ) { if ( ! isset( $allowed_options['elementor'] ) ) { return $allowed_options; } $sorted = Collection::make(); $visited = Collection::make(); $sort = function ( $item ) use ( &$sort, $sorted, $visited ) { if ( $visited->contains( $item ) ) { return; } $visited->push( $item ); $feature = $this->get_features( $item ); if ( ! $feature ) { return; } foreach ( $feature['dependencies'] ?? [] as $dep ) { $name = is_string( $dep ) ? $dep : $dep->get_name(); $sort( $name ); } $sorted->push( $item ); }; foreach ( $allowed_options['elementor'] as $option ) { $is_experiment_option = strpos( $option, static::OPTION_PREFIX ) === 0; if ( ! $is_experiment_option ) { continue; } $sort( str_replace( static::OPTION_PREFIX, '', $option ) ); } $allowed_options['elementor'] = Collection::make( $allowed_options['elementor'] ) ->filter( function ( $option ) { return 0 !== strpos( $option, static::OPTION_PREFIX ); } ) ->merge( $sorted->map( function ( $item ) { return static::OPTION_PREFIX . $item; } ) ) ->values(); return $allowed_options; } public function __construct() { $this->init_states(); $this->init_release_statuses(); $this->init_features(); add_action( 'admin_init', function () { System_Info::add_report( 'experiments', [ 'file_name' => __DIR__ . '/experiments-reporter.php', 'class_name' => __NAMESPACE__ . '\Experiments_Reporter', ] ); }, 79 /* Before log */ ); if ( is_admin() ) { $page_id = Settings::PAGE_ID; add_action( "elementor/admin/after_create_settings/{$page_id}", function( Settings $settings ) { $this->register_settings_fields( $settings ); }, 11 ); add_filter( 'allowed_options', function ( $allowed_options ) { return $this->sort_allowed_options_by_dependencies( $allowed_options ); }, 11 ); } // Register CLI commands. if ( Utils::is_wp_cli() ) { \WP_CLI::add_command( 'elementor experiments', WP_CLI::class ); } } /** * @param array $experimental_data * @return array * @throws Dependency_Exception */ private function initialize_feature_dependencies( array $experimental_data ): array { foreach ( $experimental_data['dependencies'] as $key => $dependency ) { $feature = $this->get_features( $dependency ); if ( ! isset( $feature ) ) { // since we must validate the state of each dependency, we have to make sure that dependencies are initialized in the correct order, otherwise, error. throw new Exceptions\Dependency_Exception( "Feature {$experimental_data['name']} cannot be initialized before dependency feature: {$dependency}." ); } if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) { throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' ); } $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature ); $experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data ); } return $experimental_data; } /** * @param array $feature * @param array $experimental_data * @return array * * we must validate the state: * * A user can set a dependant feature to inactive and in upgrade we don't change users settings. * * A developer can set the default state to be invalid (e.g. dependant feature is inactive). * if one of the dependencies is inactive, the main feature should be inactive as well. */ private function set_feature_default_state_to_match_dependencies( array $feature, array $experimental_data ): array { if ( self::STATE_INACTIVE !== $this->get_feature_actual_state( $feature ) ) { return $experimental_data; } if ( self::STATE_ACTIVE === $experimental_data['state'] ) { $experimental_data['state'] = self::STATE_INACTIVE; } elseif ( self::STATE_DEFAULT === $experimental_data['state'] ) { $experimental_data['default'] = self::STATE_INACTIVE; } return $experimental_data; } /** * @param $new_site * @param array $experimental_data * @return array */ private function set_new_site_default_state( $new_site, array $experimental_data ): array { if ( ! $this->install_compare( $new_site['minimum_installation_version'] ) ) { return $experimental_data; } if ( $new_site['always_active'] ) { $experimental_data['state'] = self::STATE_ACTIVE; $experimental_data['mutable'] = false; } elseif ( $new_site['default_active'] ) { $experimental_data['default'] = self::STATE_ACTIVE; } elseif ( $new_site['default_inactive'] ) { $experimental_data['default'] = self::STATE_INACTIVE; } return $experimental_data; } /** * @param array $options * @return array */ private function set_feature_initial_options( array $options ): array { $default_experimental_data = [ 'tag' => '', // Deprecated, use 'tags' instead. 'tags' => [], 'description' => '', 'release_status' => self::RELEASE_STATUS_ALPHA, 'default' => self::STATE_INACTIVE, 'mutable' => true, static::TYPE_HIDDEN => false, 'new_site' => [ 'always_active' => false, 'default_active' => false, 'default_inactive' => false, 'minimum_installation_version' => null, ], 'on_state_change' => null, 'generator_tag' => false, 'deprecated' => false, ]; $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages', 'deprecated' ]; $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options ); return $this->unify_feature_tags( $experimental_data ); } }