PluginProbe
Elementor Website Builder – more than just a page builder / 3.34.1
Elementor Website Builder – more than just a page builder v3.34.1
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 | app/modules/onboarding/module.php +448 -237 4.2.33.34.1 View file →
@@ -1,352 +1,563 @@
1 1 <?php
2 -
3 2 namespace Elementor\App\Modules\Onboarding;
4 3
5 -use Elementor\App\Modules\Onboarding\Data\Controller;
6 -use Elementor\App\Modules\Onboarding\Storage\Entities\User_Choices;
7 -use Elementor\App\Modules\Onboarding\Storage\Entities\User_Progress;
8 -use Elementor\App\Modules\Onboarding\Storage\Onboarding_Progress_Manager;
4 +use Automatic_Upgrader_Skin;
9 5 use Elementor\Core\Base\Module as BaseModule;
10 -use Elementor\Core\Settings\Manager as SettingsManager;
6 +use Elementor\Core\Common\Modules\Ajax\Module as Ajax;
7 +use Elementor\Core\Common\Modules\Connect\Apps\Library;
8 +use Elementor\Core\Files\Uploads_Manager;
11 9 use Elementor\Includes\EditorAssetsAPI;
12 10 use Elementor\Plugin;
13 11 use Elementor\Utils;
12 +use Plugin_Upgrader;
14 13
15 14 if ( ! defined( 'ABSPATH' ) ) {
16 - exit;
15 + exit; // Exit if accessed directly.
17 16 }
18 17
18 +/**
19 + * Onboarding Module
20 + *
21 + * Responsible for initializing Elementor App functionality
22 + *
23 + * @since 3.6.0
24 + */
19 25 class Module extends BaseModule {
20 26
21 - const VERSION = '2.0.0';
22 - const ASSETS_BASE_URL = 'https://assets.elementor.com/onboarding/v1/strings/';
27 + const VERSION = '1.0.0';
23 28 const ONBOARDING_OPTION = 'elementor_onboarded';
24 29
25 - const SUPPORTED_LOCALES = [
26 - 'de_DE' => 'de',
27 - 'es_ES' => 'es',
28 - 'fr_FR' => 'fr',
29 - 'he_IL' => 'he',
30 - 'id_ID' => 'id',
31 - 'it_IT' => 'it',
32 - 'nl_NL' => 'nl',
33 - 'pl_PL' => 'pl',
34 - 'pt_BR' => 'pt',
35 - 'tr_TR' => 'tr',
36 - ];
30 + const EXPERIMENT_EMPHASIZE_CONNECT_BENEFITS = 'emphasizeConnectBenefits101';
31 + const EXPERIMENT_OFFER_THEME_CHOICES_HELLO_BIZ = 'offerThemeChoicesHelloBiz201';
32 + const EXPERIMENT_EMPHASIZE_THEME_VALUE_AUDIENCE_202 = 'emphasizeThemeValueAudience202';
33 + const EXPERIMENT_UPDATE_COPY_VISUALS = 'updateCopyVisuals401';
34 + const EXPERIMENT_REDUCE_HIERARCHY_BLANK_OPTION = 'reduceHierarchyBlankOption402';
37 35
38 - private Onboarding_Progress_Manager $progress_manager;
36 + private ?API $editor_assets_api = null;
39 37
40 - public function get_name(): string {
38 + /**
39 + * Get name.
40 + *
41 + * @since 3.6.0
42 + * @access public
43 + *
44 + * @return string
45 + */
46 + public function get_name() {
41 47 return 'onboarding';
42 48 }
43 49
44 - public static function has_user_finished_onboarding(): bool {
45 - return (bool) get_option( self::ONBOARDING_OPTION );
46 - }
50 + private function is_experiment_enabled( string $experiment_key ) {
51 + $editor_assets_api = $this->get_editor_assets_api();
47 52
48 - public function __construct() {
49 - $this->progress_manager = Onboarding_Progress_Manager::instance();
53 + if ( null === $editor_assets_api ) {
54 + return false;
55 + }
50 56
51 - Plugin::instance()->data_manager_v2->register_controller( new Controller() );
57 + return $editor_assets_api->is_experiment_enabled( $experiment_key );
58 + }
52 59
53 - add_action( 'elementor/init', [ $this, 'on_elementor_init' ], 12 );
60 + private function is_hello_theme_activated(): bool {
61 + $current_theme = get_option( 'template' );
62 + $hello_theme_variants = [ 'hello-elementor', 'hello-biz', 'hello-commerce', 'hello-theme' ];
54 63
55 - if ( $this->should_show_starter() ) {
56 - add_filter( 'elementor/editor/localize_settings', [ $this, 'add_starter_settings' ] );
57 - add_filter( 'elementor/editor/v2/packages', [ $this, 'add_starter_packages' ] );
58 - add_action( 'elementor/editor/v2/styles/enqueue', [ $this, 'enqueue_fonts' ] );
59 - add_action( 'elementor/preview/enqueue_styles', [ $this, 'enqueue_starter_preview_css' ] );
60 - }
64 + return in_array( $current_theme, $hello_theme_variants, true );
61 65 }
62 66
63 - public function on_elementor_init(): void {
64 - if ( ! Plugin::instance()->app->is_current() ) {
65 - return;
67 + private function get_editor_assets_api(): ?API {
68 + if ( null !== $this->editor_assets_api ) {
69 + return $this->editor_assets_api;
66 70 }
67 71
68 - $this->set_onboarding_settings();
69 - $this->enqueue_fonts();
70 - }
72 + $editor_assets_api_instance = new EditorAssetsAPI( $this->get_editor_assets_api_config() );
73 + $this->editor_assets_api = new API( $editor_assets_api_instance );
71 74
72 - public function enqueue_fonts(): void {
73 - wp_enqueue_style(
74 - 'elementor-onboarding-fonts',
75 - 'https://fonts.googleapis.com/css2?family=Poppins:wght@500&display=swap',
76 - [],
77 - ELEMENTOR_VERSION
78 - );
75 + return $this->editor_assets_api;
79 76 }
80 77
81 - public function enqueue_starter_preview_css(): void {
82 - $css = '
83 - #site-header,
84 - .page-header { display: var(--e-starter-header-display, none); }
85 - ';
86 -
87 - wp_register_style( 'elementor-starter-preview', false );
88 - wp_enqueue_style( 'elementor-starter-preview' );
89 - wp_add_inline_style( 'elementor-starter-preview', $css );
78 + private function get_editor_assets_api_config(): array {
79 + return [
80 + EditorAssetsAPI::ASSETS_DATA_URL => 'https://assets.elementor.com/ab-testing/v1/ab-testing.json',
81 + EditorAssetsAPI::ASSETS_DATA_TRANSIENT_KEY => '_elementor_ab_testing_data',
82 + EditorAssetsAPI::ASSETS_DATA_KEY => 'ab-testing',
83 + ];
90 84 }
91 85
92 - public function progress_manager(): Onboarding_Progress_Manager {
93 - return $this->progress_manager;
94 - }
95 -
96 - private function set_onboarding_settings(): void {
97 - if ( ! Plugin::instance()->common ) {
86 + /**
87 + * Set Onboarding Settings
88 + *
89 + * Creates an array of module settings that is localized into the JS App config.
90 + *
91 + * @since 3.6.0
92 + */
93 + private function set_onboarding_settings() {
94 + if ( ! Plugin::$instance->common ) {
98 95 return;
99 96 }
100 97
101 - $progress = $this->progress_manager->get_progress();
102 - $choices = $this->progress_manager->get_choices();
103 - $steps = $this->get_steps_config();
98 + // Get the published pages and posts
99 + $pages_and_posts = new \WP_Query( [
100 + 'post_type' => [ 'page', 'post' ],
101 + 'post_status' => 'publish',
102 + 'update_post_meta_cache' => false,
103 + 'update_post_term_cache' => false,
104 + 'no_found_rows' => true,
105 + ] );
104 106
105 - // If the user previously selected a theme but it's no longer the active theme,
106 - // clear the theme selection so the user can re-select.
107 - $this->maybe_invalidate_theme_selection( $progress, $choices );
107 + $custom_site_logo_id = get_theme_mod( 'custom_logo' );
108 + $custom_logo_src = wp_get_attachment_image_src( $custom_site_logo_id, 'full' );
109 + $site_name = get_option( 'blogname', '' );
108 110
109 - $is_connected = $this->is_user_connected();
111 + $hello_theme = wp_get_theme( 'hello-elementor' );
112 + $hello_theme_errors = is_object( $hello_theme->errors() ) ? $hello_theme->errors()->errors : [];
110 113
114 + /** @var Library $library */
115 + $library = Plugin::$instance->common->get_component( 'connect' )->get_app( 'library' );
116 +
111 117 Plugin::$instance->app->set_settings( 'onboarding', [
112 - 'version' => self::VERSION,
113 - 'restUrl' => rest_url( 'elementor/v1/onboarding/' ),
114 - 'nonce' => wp_create_nonce( 'wp_rest' ),
115 - 'progress' => $this->validate_progress_for_steps( $progress, $steps ),
116 - 'choices' => $choices->to_array(),
117 - 'hadUnexpectedExit' => $progress->had_unexpected_exit( self::has_user_finished_onboarding() ),
118 - 'isConnected' => $is_connected,
119 - 'userName' => $this->get_user_display_name(),
120 - 'steps' => $steps,
121 - 'uiTheme' => $this->get_ui_theme_preference(),
122 - 'translations' => $this->get_translated_strings(),
123 - 'shouldShowProInstallScreen' => $is_connected ? $this->should_show_pro_install_screen() : false,
124 - 'isHelloThemeActive' => $this->is_hello_theme_active(),
118 + 'eventPlacement' => 'Onboarding wizard',
119 + 'onboardingAlreadyRan' => get_option( self::ONBOARDING_OPTION ),
120 + 'onboardingVersion' => self::VERSION,
121 + 'isLibraryConnected' => $library->is_connected(),
122 + // Used to check if the Hello Elementor theme is installed but not activated.
123 + 'helloInstalled' => empty( $hello_theme_errors['theme_not_found'] ),
124 + 'helloActivated' => $this->is_hello_theme_activated(),
125 + // The "Use Hello theme on my site" checkbox should be checked by default only if this condition is met.
126 + 'helloOptOut' => count( $pages_and_posts->posts ) < 5,
127 + 'siteName' => esc_html( $site_name ),
128 + 'isUnfilteredFilesEnabled' => Uploads_Manager::are_unfiltered_uploads_enabled(),
125 129 'urls' => [
126 - 'dashboard' => admin_url(),
127 - 'editor' => admin_url( 'edit.php?post_type=elementor_library' ),
128 - 'connect' => $this->get_connect_url(),
129 - 'signUp' => $this->get_connect_url( 'signup' ),
130 - 'comparePlans' => 'https://go.elementor.com/go-pro-onboarding-editor-features-step-upgrade/',
130 + 'kitLibrary' => Plugin::$instance->app->get_base_url() . '&source=onboarding#/kit-library?order[direction]=desc&order[by]=featuredIndex',
131 + 'sitePlanner' => add_query_arg( [
132 + 'type' => 'editor',
133 + 'siteUrl' => esc_url( home_url() ),
134 + 'siteName' => esc_html( $site_name ),
135 + 'siteDescription' => esc_html( get_bloginfo( 'description' ) ),
136 + 'siteLanguage' => get_locale(),
137 + ], 'https://planner.elementor.com/onboarding.html' ),
131 138 'createNewPage' => Plugin::$instance->documents->get_create_new_post_url(),
132 - 'upgradeUrl' => 'https://go.elementor.com/go-pro-onboarding-editor-header-upgrade/',
139 + 'connect' => $library->get_admin_url( 'authorize', [
140 + 'utm_source' => 'onboarding-wizard',
141 + 'utm_campaign' => 'connect-account',
142 + 'utm_medium' => 'wp-dash',
143 + 'utm_term' => self::VERSION,
144 + 'source' => 'generic',
145 + ] ),
146 + 'upgrade' => 'https://go.elementor.com/go-pro-onboarding-wizard-upgrade/',
147 + 'signUp' => $library->get_admin_url( 'authorize', [
148 + 'utm_source' => 'onboarding-wizard',
149 + 'utm_campaign' => 'connect-account',
150 + 'utm_medium' => 'wp-dash',
151 + 'utm_term' => self::VERSION,
152 + 'source' => 'generic',
153 + 'screen_hint' => 'signup',
154 + ] ),
155 + 'uploadPro' => Plugin::$instance->app->get_base_url() . '#/onboarding/uploadAndInstallPro?mode=popup',
133 156 ],
157 + 'siteLogo' => [
158 + 'id' => $custom_site_logo_id,
159 + 'url' => $custom_logo_src ? $custom_logo_src[0] : '',
160 + ],
161 + 'utms' => [
162 + 'connectTopBar' => '&utm_content=top-bar',
163 + 'connectCta' => '&utm_content=cta-button',
164 + 'connectCtaLink' => '&utm_content=cta-link',
165 + 'downloadPro' => '?utm_source=onboarding-wizard&utm_campaign=my-account-subscriptions&utm_medium=wp-dash&utm_content=import-pro-plugin&utm_term=' . self::VERSION,
166 + ],
167 + 'nonce' => wp_create_nonce( 'onboarding' ),
168 + 'experiment' => true,
169 + 'isExperiment101Enabled' => $this->is_experiment_enabled( self::EXPERIMENT_EMPHASIZE_CONNECT_BENEFITS ),
170 + 'isExperiment201Enabled' => $this->is_experiment_enabled( self::EXPERIMENT_OFFER_THEME_CHOICES_HELLO_BIZ ),
171 + 'isExperiment202Enabled' => $this->is_experiment_enabled( self::EXPERIMENT_EMPHASIZE_THEME_VALUE_AUDIENCE_202 ),
172 + 'isExperiment401Enabled' => $this->is_experiment_enabled( self::EXPERIMENT_UPDATE_COPY_VISUALS ),
173 + 'isExperiment402Enabled' => $this->is_experiment_enabled( self::EXPERIMENT_REDUCE_HIERARCHY_BLANK_OPTION ),
174 + 'experimentNames' => [
175 + '101' => self::EXPERIMENT_EMPHASIZE_CONNECT_BENEFITS,
176 + '201' => self::EXPERIMENT_OFFER_THEME_CHOICES_HELLO_BIZ,
177 + '202' => self::EXPERIMENT_EMPHASIZE_THEME_VALUE_AUDIENCE_202,
178 + '401' => self::EXPERIMENT_UPDATE_COPY_VISUALS,
179 + '402' => self::EXPERIMENT_REDUCE_HIERARCHY_BLANK_OPTION,
180 + ],
134 181 ] );
135 182 }
136 183
137 - private function validate_progress_for_steps( User_Progress $progress, array $steps ): array {
138 - $progress_data = $progress->to_array();
139 - $step_ids = array_column( $steps, 'id' );
140 - $step_count = count( $steps );
141 - $fallback_step_id = $steps[0]['id'] ?? 'site_features';
142 - $current_step_index = $progress->get_current_step_index() ?? 0;
143 - $current_step_id = $progress->get_current_step_id() ?? $fallback_step_id;
184 + /**
185 + * Get Permission Error Response
186 + *
187 + * Returns the response that is returned when the user's capabilities are not sufficient for performing an action.
188 + *
189 + * @since 3.6.4
190 + *
191 + * @return array
192 + */
193 + private function get_permission_error_response() {
194 + return [
195 + 'status' => 'error',
196 + 'payload' => [
197 + 'error_message' => esc_html__( 'You do not have permission to perform this action.', 'elementor' ),
198 + ],
199 + ];
200 + }
144 201
145 - $is_invalid_step_index = $current_step_index < 0 || $current_step_index >= $step_count;
146 - $is_invalid_step_id = ! in_array( $current_step_id, $step_ids, true );
202 + /**
203 + * Maybe Update Site Logo
204 + *
205 + * If a new name is provided, it will be updated as the Site Name.
206 + *
207 + * @since 3.6.0
208 + *
209 + * @return array
210 + */
211 + private function maybe_update_site_name() {
212 + $problem_error = [
213 + 'status' => 'error',
214 + 'payload' => [
215 + 'error_message' => esc_html__( 'There was a problem setting your site name.', 'elementor' ),
216 + ],
217 + ];
147 218
148 - if ( $is_invalid_step_index || $is_invalid_step_id ) {
149 - $current_step_id = $fallback_step_id;
150 - $current_step_index = 0;
219 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
220 + if ( empty( $_POST['data'] ) ) {
221 + return $problem_error;
151 222 }
152 223
153 - $progress_data['current_step_id'] = $current_step_id;
154 - $progress_data['current_step_index'] = $current_step_index;
155 - $progress_data['completed_steps'] = array_values( array_filter(
156 - $progress->get_completed_steps(),
157 - static fn( $step_id ) => in_array( $step_id, $step_ids, true )
158 - ) );
224 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
225 + $data = json_decode( Utils::get_super_global_value( $_POST, 'data' ), true );
159 226
160 - return $progress_data;
161 - }
227 + if ( ! isset( $data['siteName'] ) ) {
228 + return $problem_error;
229 + }
162 230
163 - private function is_user_connected(): bool {
164 - $library = $this->get_library_app();
231 + /**
232 + * Onboarding Site Name
233 + *
234 + * Filters the new site name passed by the user to update in Elementor's onboarding process.
235 + * Elementor runs `esc_html()` on the Site Name passed by the user for security reasons. If a user wants to
236 + * include special characters in their site name, they can use this filter to override it.
237 + *
238 + * @since 3.6.0
239 + *
240 + * @param string Escaped new site name
241 + */
242 + $new_site_name = apply_filters( 'elementor/onboarding/site-name', $data['siteName'] );
165 243
166 - return $library ? $library->is_connected() : false;
244 + // The site name is sanitized in `update_options()`
245 + update_option( 'blogname', $new_site_name );
246 +
247 + return [
248 + 'status' => 'success',
249 + 'payload' => [
250 + 'siteNameUpdated' => true,
251 + ],
252 + ];
167 253 }
168 254
169 - private function get_connect_url( string $screen_hint = '' ): string {
170 - $library = $this->get_library_app();
171 -
172 - if ( ! $library ) {
173 - return '';
255 + /**
256 + * Maybe Update Site Logo
257 + *
258 + * If an image attachment ID is provided, it will be updated as the Site Logo Theme Mod.
259 + *
260 + * @since 3.6.0
261 + *
262 + * @return array
263 + */
264 + private function maybe_update_site_logo() {
265 + if ( ! current_user_can( 'edit_theme_options' ) ) {
266 + return $this->get_permission_error_response();
174 267 }
175 268
176 - return $library->get_admin_url( 'authorize', [
177 - 'utm_source' => 'onboarding-wizard',
178 - 'utm_campaign' => 'connect-account',
179 - 'utm_medium' => 'wp-dash',
180 - 'utm_term' => self::VERSION,
181 - 'source' => 'generic',
182 - 'screen_hint' => $screen_hint,
183 - ] ) ?? '';
184 - }
269 + $data_error = [
270 + 'status' => 'error',
271 + 'payload' => [
272 + 'error_message' => esc_html__( 'There was a problem setting your site logo.', 'elementor' ),
273 + ],
274 + ];
185 275
186 - private function get_library_app() {
187 - $connect = Plugin::instance()->common->get_component( 'connect' );
188 -
189 - if ( ! $connect ) {
190 - return null;
276 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
277 + if ( empty( $_POST['data'] ) ) {
278 + return $data_error;
191 279 }
192 280
193 - return $connect->get_app( 'library' );
194 - }
281 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
282 + $data = json_decode( Utils::get_super_global_value( $_POST, 'data' ), true );
195 283
196 - public static function should_show_pro_install_screen(): bool {
197 - if ( Utils::has_pro() || Utils::is_pro_installed_and_not_active() ) {
198 - return false;
284 + // If there is no attachment ID passed or it is not a valid ID, exit here.
285 + if ( empty( $data['attachmentId'] ) ) {
286 + return $data_error;
199 287 }
200 288
201 - $connect = Plugin::$instance->common->get_component( 'connect' );
289 + $absint_attachment_id = absint( $data['attachmentId'] );
202 290
203 - if ( ! $connect ) {
204 - return false;
291 + if ( 0 === $absint_attachment_id ) {
292 + return $data_error;
205 293 }
206 294
207 - $pro_install_app = $connect->get_app( 'pro-install' );
295 + $attachment_url = wp_get_attachment_url( $data['attachmentId'] );
208 296
209 - if ( ! $pro_install_app || ! $pro_install_app->is_connected() ) {
210 - return false;
297 + // Check if the attachment exists. If it does not, exit here.
298 + if ( ! $attachment_url ) {
299 + return $data_error;
211 300 }
212 301
213 - $download_link = $pro_install_app->get_download_link();
302 + set_theme_mod( 'custom_logo', $absint_attachment_id );
214 303
215 - return ! empty( $download_link );
304 + return [
305 + 'status' => 'success',
306 + 'payload' => [
307 + 'siteLogoUpdated' => true,
308 + ],
309 + ];
216 310 }
217 311
218 - private function get_ui_theme_preference(): string {
219 - $editor_preferences = SettingsManager::get_settings_managers( 'editorPreferences' );
312 + /**
313 + * Maybe Upload Logo Image
314 + *
315 + * If an image file upload is provided, and it passes validation, it will be uploaded to the site's Media Library.
316 + *
317 + * @since 3.6.0
318 + *
319 + * @return array
320 + */
321 + private function maybe_upload_logo_image() {
322 + $error_message = esc_html__( 'There was a problem uploading your file.', 'elementor' );
220 323
221 - $ui_theme = $editor_preferences->get_model()->get_settings( 'ui_theme' );
324 + $file = Utils::get_super_global_value( $_FILES, 'fileToUpload' ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
222 325
223 - return $ui_theme ? $ui_theme : 'auto';
224 - }
326 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
327 + if ( ! is_array( $file ) || empty( $file['type'] ) ) {
328 + return [
329 + 'status' => 'error',
330 + 'payload' => [
331 + 'error_message' => $error_message,
332 + ],
333 + ];
334 + }
225 335
226 - private function get_user_display_name(): string {
227 - $library = $this->get_library_app();
336 + // If the user has allowed it, set the Request's state as an "Elementor Upload" request, in order to add
337 + // support for non-standard file uploads.
338 + if ( 'image/svg+xml' === $file['type'] ) {
339 + if ( Uploads_Manager::are_unfiltered_uploads_enabled() ) {
340 + Plugin::$instance->uploads_manager->set_elementor_upload_state( true );
341 + } else {
342 + wp_send_json_error( 'To upload SVG files, you must allow uploading unfiltered files.' );
343 + }
344 + }
228 345
229 - if ( ! $library || ! $library->is_connected() ) {
230 - return '';
346 + // If the image is an SVG file, sanitation is performed during the import (upload) process.
347 + $image_attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import( $file );
348 +
349 + if ( 'image/svg+xml' === $file['type'] && Uploads_Manager::are_unfiltered_uploads_enabled() ) {
350 + // Reset Upload state.
351 + Plugin::$instance->uploads_manager->set_elementor_upload_state( false );
231 352 }
232 353
233 - $user = $library->get( 'user' );
354 + if ( $image_attachment && ! is_wp_error( $image_attachment ) ) {
355 + $result = [
356 + 'status' => 'success',
357 + 'payload' => [
358 + 'imageAttachment' => $image_attachment,
359 + ],
360 + ];
361 + } else {
362 + $result = [
363 + 'status' => 'error',
364 + 'payload' => [
365 + 'error_message' => $error_message,
366 + ],
367 + ];
368 + }
234 369
235 - return $user->first_name ?? '';
370 + return $result;
236 371 }
237 372
238 - public function should_show_starter(): bool {
239 - $progress = $this->progress_manager->get_progress();
373 + /**
374 + * Activate Hello Theme
375 + *
376 + * @since 3.6.0
377 + *
378 + * @return array
379 + */
380 + private function maybe_activate_hello_theme() {
381 + if ( ! current_user_can( 'switch_themes' ) ) {
382 + return $this->get_permission_error_response();
383 + }
240 384
241 - return self::VERSION === get_option( self::ONBOARDING_OPTION ) && ! $progress->is_starter_dismissed();
242 - }
385 + $theme_slug = Utils::get_super_global_value( $_POST, 'theme_slug' ) ?? 'hello-biz'; // phpcs:ignore WordPress.Security.NonceVerification.Missing
386 + $allowed_themes = [ 'hello-elementor', 'hello-biz' ];
387 + if ( ! in_array( $theme_slug, $allowed_themes, true ) ) {
388 + $theme_slug = 'hello-biz';
389 + }
243 390
244 - public function add_starter_packages( array $packages ): array {
245 - $packages[] = 'editor-starter';
391 + switch_theme( $theme_slug );
246 392
247 - return $packages;
248 - }
249 -
250 - public function add_starter_settings( array $settings ): array {
251 - $settings['starter'] = [
252 - 'restPath' => 'elementor/v1/onboarding/user-progress',
253 - 'aiPlannerUrl' => 'https://planner.elementor.com/home.html',
254 - 'kitLibraryUrl' => Plugin::$instance->app->get_base_url() . '#/kit-library',
393 + return [
394 + 'status' => 'success',
395 + 'payload' => [
396 + 'helloThemeActivated' => true,
397 + ],
255 398 ];
256 -
257 - return $settings;
258 399 }
259 400
260 - private function maybe_invalidate_theme_selection( User_Progress $progress, User_Choices $choices ): void {
261 - $selected_theme = $choices->get_theme_selection();
262 -
263 - if ( empty( $selected_theme ) ) {
264 - return;
401 + /**
402 + * Upload and Install Elementor Pro
403 + *
404 + * @since 3.6.0
405 + *
406 + * @return array
407 + */
408 + private function upload_and_install_pro() {
409 + if ( ! current_user_can( 'install_plugins' ) || ! current_user_can( 'activate_plugins' ) ) {
410 + return $this->get_permission_error_response();
265 411 }
266 412
267 - $active_theme = get_stylesheet();
413 + $error_message = esc_html__( 'There was a problem uploading your file.', 'elementor' );
268 414
269 - if ( $active_theme !== $selected_theme ) {
270 - $completed = $this->filter_out_theme_selection_step( $progress->get_completed_steps() );
271 - $progress->set_completed_steps( $completed );
272 - $this->progress_manager->save_progress( $progress );
415 + $file = Utils::get_super_global_value( $_FILES, 'fileToUpload' ) ?? []; // phpcs:ignore WordPress.Security.NonceVerification.Missing
273 416
274 - $choices->set_theme_selection( null );
275 - $this->progress_manager->save_choices( $choices );
417 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
418 + if ( ! is_array( $file ) || empty( $file['type'] ) ) {
419 + return [
420 + 'status' => 'error',
421 + 'payload' => [
422 + 'error_message' => $error_message,
423 + ],
424 + ];
276 425 }
277 - }
278 426
279 - private function filter_out_theme_selection_step( array $steps ): array {
280 - return array_values( array_filter( $steps, function ( $step ) {
281 - return 'theme_selection' !== $step;
282 - } ) );
283 - }
427 + $result = [];
284 428
285 - private function get_translated_strings(): array {
286 - $locale = $this->get_onboarding_locale();
429 + if ( ! class_exists( 'Automatic_Upgrader_Skin' ) ) {
430 + require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
431 + }
287 432
288 - $api = new EditorAssetsAPI( [
289 - EditorAssetsAPI::ASSETS_DATA_URL => self::ASSETS_BASE_URL . $locale . '.json',
290 - EditorAssetsAPI::ASSETS_DATA_TRANSIENT_KEY => '_elementor_onboarding_strings_' . $locale,
291 - EditorAssetsAPI::ASSETS_DATA_KEY => 'translations',
292 - ] );
433 + $skin = new Automatic_Upgrader_Skin();
434 + $upgrader = new Plugin_Upgrader( $skin );
435 + $upload_result = $upgrader->install( $file['tmp_name'], [ 'overwrite_package' => false ] );
293 436
294 - return $api->get_assets_data();
295 - }
437 + if ( ! $upload_result || is_wp_error( $upload_result ) ) {
438 + $result = [
439 + 'status' => 'error',
440 + 'payload' => [
441 + 'error_message' => $error_message,
442 + ],
443 + ];
444 + } else {
445 + $activated = activate_plugin( WP_PLUGIN_DIR . '/elementor-pro/elementor-pro.php', false, false, true );
296 446
297 - private function get_onboarding_locale(): string {
298 - static $flipped_locales = null;
299 -
300 - if ( null === $flipped_locales ) {
301 - $flipped_locales = array_flip( self::SUPPORTED_LOCALES );
447 + if ( ! is_wp_error( $activated ) ) {
448 + $result = [
449 + 'status' => 'success',
450 + 'payload' => [
451 + 'elementorProInstalled' => true,
452 + ],
453 + ];
454 + } else {
455 + $result = [
456 + 'status' => 'error',
457 + 'payload' => [
458 + 'error_message' => $error_message,
459 + 'elementorProInstalled' => false,
460 + ],
461 + ];
462 + }
302 463 }
303 464
304 - $user_locale = get_user_locale();
465 + return $result;
466 + }
305 467
306 - if ( isset( self::SUPPORTED_LOCALES[ $user_locale ] ) ) {
307 - return $user_locale;
308 - }
468 + private function maybe_update_onboarding_db_option() {
469 + $db_option = get_option( self::ONBOARDING_OPTION );
309 470
310 - $locale = substr( $user_locale, 0, 2 );
311 -
312 - if ( isset( $flipped_locales[ $locale ] ) ) {
313 - return $flipped_locales[ $locale ];
471 + if ( ! $db_option ) {
472 + update_option( self::ONBOARDING_OPTION, true );
314 473 }
315 474
316 - return 'en';
475 + return [
476 + 'status' => 'success',
477 + 'payload' => 'onboarding DB',
478 + ];
317 479 }
318 480
319 - private function get_steps_config(): array {
320 - $steps = [
321 - [
322 - 'id' => 'theme_selection',
323 - 'label' => __( 'Start with a theme that fits your needs', 'elementor' ),
324 - 'type' => 'single',
325 - ],
326 - ];
481 + /**
482 + * Maybe Handle Ajax
483 + *
484 + * This method checks if there are any AJAX actions being
485 + *
486 + * @since 3.6.0
487 + */
488 + private function maybe_handle_ajax() {
489 + $result = [];
327 490
328 - if ( ! self::is_elementor_pro_installed() ) {
329 - $steps[] = [
330 - 'id' => 'site_features',
331 - 'label' => __( 'What do you want to include in your site?', 'elementor' ),
332 - 'type' => 'multiple',
333 - ];
491 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
492 + switch ( Utils::get_super_global_value( $_POST, 'action' ) ) {
493 + case 'elementor_update_site_name':
494 + // If no value is passed for any reason, no need to update the site name.
495 + $result = $this->maybe_update_site_name();
496 + break;
497 + case 'elementor_update_site_logo':
498 + $result = $this->maybe_update_site_logo();
499 + break;
500 + case 'elementor_upload_site_logo':
501 + $result = $this->maybe_upload_logo_image();
502 + break;
503 + case 'elementor_activate_hello_theme':
504 + $result = $this->maybe_activate_hello_theme();
505 + break;
506 + case 'elementor_upload_and_install_pro':
507 + $result = $this->upload_and_install_pro();
508 + break;
509 + case 'elementor_update_onboarding_option':
510 + $result = $this->maybe_update_onboarding_db_option();
511 + break;
512 + case 'elementor_save_onboarding_features':
513 + // phpcs:ignore WordPress.Security.NonceVerification.Missing
514 + $result = $this->get_component( 'features_usage' )->save_onboarding_features( Utils::get_super_global_value( $_POST, 'data' ) ?? [] );
334 515 }
335 516
336 - return apply_filters( 'elementor/onboarding/steps', $steps );
517 + if ( ! empty( $result ) ) {
518 + if ( 'success' === $result['status'] ) {
519 + wp_send_json_success( $result['payload'] );
520 + } else {
521 + wp_send_json_error( $result['payload'] );
522 + }
523 + }
337 524 }
338 525
339 - private static function is_elementor_pro_installed(): bool {
340 - $is_pro_installed = Utils::has_pro();
341 - return (bool) apply_filters( 'elementor/onboarding/is_elementor_pro_installed', $is_pro_installed );
342 - }
526 + public function __construct() {
527 + $this->add_component( 'features_usage', new Features_Usage() );
343 528
344 - private function is_hello_theme_active(): bool {
345 - $active_theme = get_stylesheet();
346 - $is_active = 0 === strpos( $active_theme, 'hello-' );
529 + add_action( 'elementor/init', function() {
530 + // Only load when viewing the onboarding app.
531 + if ( Plugin::$instance->app->is_current() ) {
532 + $this->set_onboarding_settings();
533 + // Needed for installing the Hello Elementor theme.
534 + wp_enqueue_script( 'updates' );
535 + // Needed for uploading Logo from WP Media Library.
536 + wp_enqueue_media();
537 + }
538 + }, 12 );
347 539
348 - $is_active = (bool) apply_filters( 'elementor/onboarding/is_hello_theme_active', $is_active );
540 + // Needed for uploading Logo from WP Media Library. The 'admin_menu' hook is used because it runs before
541 + // 'admin_init', and the App triggers printing footer scripts on 'admin_init' at priority 0.
542 + add_action( 'admin_menu', function () {
543 + add_action( 'wp_print_footer_scripts', function () {
544 + if ( function_exists( 'wp_print_media_templates' ) ) {
545 + wp_print_media_templates();
546 + }
547 + } );
548 + } );
349 549
350 - return (bool) apply_filters( 'elementor/onboarding/is_elementor_theme_active', $is_active );
550 + add_action( 'admin_init', function() {
551 + if ( wp_doing_ajax() &&
552 + isset( $_POST['action'] ) &&
553 + isset( $_POST['_nonce'] ) &&
554 + wp_verify_nonce( Utils::get_super_global_value( $_POST, '_nonce' ), Ajax::NONCE_KEY ) &&
555 + current_user_can( 'manage_options' )
556 + ) {
557 + $this->maybe_handle_ajax();
558 + }
559 + } );
560 +
561 + $this->get_component( 'features_usage' )->register();
351 562 }
352 563 }