PluginProbe
Elementor Website Builder – more than just a page builder / 4.2.0
Elementor Website Builder – more than just a page builder v4.2.0
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
elementor / core / base / document.php

document.php in Elementor Website Builder – more than just a page builder 4.2.0, at core/base/document.php

2,134 lines 52.6 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 namespace Elementor\Core\Base;
3
4 use Elementor\Core\Base\Elements_Iteration_Actions\Assets as Assets_Iteration_Action;
5 use Elementor\Core\Base\Elements_Iteration_Actions\Base as Elements_Iteration_Action;
6 use Elementor\Core\Behaviors\Interfaces\Lock_Behavior;
7 use Elementor\Core\Files\CSS\Post as Post_CSS;
8 use Elementor\Core\Settings\Page\Model as Page_Model;
9 use Elementor\Core\Utils\Collection;
10 use Elementor\Core\Utils\Exceptions;
11 use Elementor\Includes\Elements\Container;
12 use Elementor\Plugin;
13 use Elementor\Controls_Manager;
14 use Elementor\Controls_Stack;
15 use Elementor\TemplateLibrary\Source_Local;
16 use Elementor\User;
17 use Elementor\Core\Settings\Manager as SettingsManager;
18 use Elementor\Utils;
19 use Elementor\Widget_Base;
20 use Elementor\Core\Settings\Page\Manager as PageManager;
21 use ElementorPro\Modules\Library\Widgets\Template;
22 use Elementor\Core\Utils\Promotions\Filtered_Promotions_Manager;
23
24 if ( ! defined( 'ABSPATH' ) ) {
25 exit; // Exit if accessed directly.
26 }
27
28 /**
29 * Elementor document.
30 *
31 * An abstract class that provides the needed properties and methods to
32 * manage and handle documents in inheriting classes.
33 *
34 * @since 2.0.0
35 * @abstract
36 */
37 abstract class Document extends Controls_Stack {
38
39 /**
40 * Document type meta key.
41 */
42 const TYPE_META_KEY = '_elementor_template_type';
43 const PAGE_META_KEY = '_elementor_page_settings';
44 const ELEMENTOR_DATA_META_KEY = '_elementor_data';
45
46 const BUILT_WITH_ELEMENTOR_META_KEY = '_elementor_edit_mode';
47
48 const CACHE_META_KEY = '_elementor_element_cache';
49
50 const UNEDITABLE_WITH_ELEMENTOR_TYPES = [ 'kit' ];
51
52 /**
53 * Document publish status.
54 */
55 const STATUS_PUBLISH = 'publish';
56
57 /**
58 * Document draft status.
59 */
60 const STATUS_DRAFT = 'draft';
61
62 /**
63 * Document private status.
64 */
65 const STATUS_PRIVATE = 'private';
66
67 /**
68 * Document autosave status.
69 */
70 const STATUS_AUTOSAVE = 'autosave';
71
72 /**
73 * Document pending status.
74 */
75 const STATUS_PENDING = 'pending';
76
77 /**
78 * @var int
79 */
80 private $main_id;
81
82 /**
83 * @var bool
84 */
85 private $is_saving = false;
86
87 private static $properties = [];
88
89 /**
90 * @var Elements_Iteration_Action[]
91 */
92 private $elements_iteration_actions = [];
93
94 /**
95 * Document post data.
96 *
97 * Holds the document post data.
98 *
99 * @since 2.0.0
100 * @access protected
101 *
102 * @var \WP_Post WordPress post data.
103 */
104 protected $post;
105
106 /**
107 * @param array $internal_elements
108 *
109 * @return array[]
110 */
111 private function get_container_elements_data( array $internal_elements ): array {
112 return [
113 [
114 'id' => Utils::generate_random_string(),
115 'elType' => 'container',
116 'elements' => $internal_elements,
117 ],
118 ];
119 }
120
121 /**
122 * @param array $internal_elements
123 *
124 * @return array[]
125 */
126 private function get_sections_elements_data( array $internal_elements ): array {
127 return [
128 [
129 'id' => Utils::generate_random_string(),
130 'elType' => 'section',
131 'elements' => [
132 [
133 'id' => Utils::generate_random_string(),
134 'elType' => 'column',
135 'elements' => $internal_elements,
136 ],
137 ],
138 ],
139 ];
140 }
141
142 /**
143 * @since 2.1.0
144 * @access protected
145 * @static
146 */
147 protected static function get_editor_panel_categories() {
148 return Plugin::$instance->elements_manager->get_categories();
149 }
150
151 /**
152 * Get properties.
153 *
154 * Retrieve the document properties.
155 *
156 * @since 2.0.0
157 * @access public
158 * @static
159 *
160 * @return array Document properties.
161 */
162 public static function get_properties() {
163 return [
164 'has_elements' => true,
165 'is_editable' => true,
166 'edit_capability' => '',
167 'show_in_finder' => true,
168 'show_on_admin_bar' => true,
169 'support_kit' => false,
170 'show_navigator' => true,
171 'allow_adding_widgets' => true,
172 'support_page_layout' => true,
173 'show_copy_and_share' => false,
174 'library_close_title' => esc_html__( 'Close', 'elementor' ),
175 'publish_button_title' => esc_html__( 'Publish', 'elementor' ),
176 'allow_closing_remote_library' => true,
177 ];
178 }
179
180 /**
181 * @since 2.1.0
182 * @access public
183 * @static
184 */
185 public static function get_editor_panel_config() {
186 $default_route = 'panel/elements/categories';
187
188 if ( ! Plugin::instance()->role_manager->user_can( 'design' ) ) {
189 $default_route = 'panel/page-settings/settings';
190 }
191
192 return [
193 'title' => static::get_title(), // JS Container title.
194 'widgets_settings' => [],
195 'elements_categories' => self::get_filtered_editor_panel_categories(),
196 'default_route' => $default_route,
197 'has_elements' => static::get_property( 'has_elements' ),
198 'support_kit' => static::get_property( 'support_kit' ),
199 'messages' => [
200 'publish_notification' => sprintf(
201 /* translators: %s: Document title. */
202 esc_html__( 'Hurray! Your %s is live.', 'elementor' ),
203 static::get_title()
204 ),
205 ],
206 'show_navigator' => static::get_property( 'show_navigator' ),
207 'allow_adding_widgets' => static::get_property( 'allow_adding_widgets' ),
208 'show_copy_and_share' => static::get_property( 'show_copy_and_share' ),
209 'library_close_title' => static::get_property( 'library_close_title' ),
210 'publish_button_title' => static::get_property( 'publish_button_title' ),
211 'allow_closing_remote_library' => static::get_property( 'allow_closing_remote_library' ),
212 ];
213 }
214
215 public static function get_filtered_editor_panel_categories(): array {
216 $categories = static::get_editor_panel_categories();
217 $has_pro = Utils::has_pro();
218
219 foreach ( $categories as $index => $category ) {
220 if ( isset( $category['promotion'] ) ) {
221 $categories = self::get_panel_category_item( $category['promotion'], $index, $categories, $has_pro );
222 }
223 }
224
225 return $categories;
226 }
227
228 /**
229 * @param $promotion
230 * @param $index
231 * @param array $categories
232 *
233 * @return array
234 */
235 private static function get_panel_category_item( $promotion, $index, array $categories, bool $has_pro ): array {
236 $keep_promotion = $has_pro && apply_filters(
237 'elementor/document/panel_category_keep_promotion',
238 false,
239 $index,
240 $promotion
241 );
242
243 if ( ! $has_pro || $keep_promotion ) {
244 $categories[ $index ]['promotion'] = Filtered_Promotions_Manager::get_filtered_promotion_data(
245 $promotion,
246 'elementor/panel/' . $index . '/custom_promotion',
247 'url'
248 );
249 } else {
250 unset( $categories[ $index ]['promotion'] );
251 }
252
253 return $categories;
254 }
255
256 /**
257 * Get element title.
258 *
259 * Retrieve the element title.
260 *
261 * @since 2.0.0
262 * @access public
263 * @static
264 *
265 * @return string Element title.
266 */
267 public static function get_title() {
268 return esc_html__( 'Document', 'elementor' );
269 }
270
271 public static function get_plural_title() {
272 return static::get_title();
273 }
274
275 public static function get_add_new_title() {
276 return sprintf(
277 /* translators: %s: Document title. */
278 esc_html__( 'Add New %s', 'elementor' ),
279 static::get_title()
280 );
281 }
282
283 /**
284 * Get property.
285 *
286 * Retrieve the document property.
287 *
288 * @since 2.0.0
289 * @access public
290 * @static
291 *
292 * @param string $key The property key.
293 *
294 * @return mixed The property value.
295 */
296 public static function get_property( $key ) {
297 $id = static::get_class_full_name();
298
299 if ( ! isset( self::$properties[ $id ] ) ) {
300 self::$properties[ $id ] = static::get_properties();
301 }
302
303 return self::get_items( self::$properties[ $id ], $key );
304 }
305
306 /**
307 * @since 2.0.0
308 * @access public
309 * @static
310 */
311 public static function get_class_full_name() {
312 return get_called_class();
313 }
314
315 public static function get_create_url() {
316 $properties = static::get_properties();
317
318 // BC Support - Each document should define it own CPT this code is for BC support.
319 $cpt = Source_Local::CPT;
320
321 if ( isset( $properties['cpt'][0] ) ) {
322 $cpt = $properties['cpt'][0];
323 }
324
325 return Plugin::$instance->documents->get_create_new_post_url( $cpt, static::get_type() );
326 }
327
328 public function get_name() {
329 return static::get_type();
330 }
331
332 /**
333 * @since 2.0.0
334 * @access public
335 */
336 public function get_unique_name() {
337 return static::get_type() . '-' . $this->post->ID;
338 }
339
340 /**
341 * @since 2.3.0
342 * @access public
343 */
344 public function get_post_type_title() {
345 $post_type_object = get_post_type_object( $this->post->post_type );
346
347 return $post_type_object->labels->singular_name;
348 }
349
350 /**
351 * @since 2.0.0
352 * @access public
353 */
354 public function get_main_id() {
355 if ( ! $this->main_id ) {
356 $post_id = $this->post->ID;
357
358 $parent_post_id = wp_is_post_revision( $post_id );
359
360 if ( $parent_post_id ) {
361 $post_id = $parent_post_id;
362 }
363
364 $this->main_id = $post_id;
365 }
366
367 return $this->main_id;
368 }
369
370 /**
371 * @return null|Lock_Behavior
372 */
373 public static function get_lock_behavior_v2() {
374 return null;
375 }
376
377 /**
378 * @since 2.0.0
379 * @access public
380 *
381 * @param $data
382 *
383 * @throws \Exception If the widget was not found.
384 *
385 * @return string
386 */
387 public function render_element( $data ) {
388 // Start buffering
389 ob_start();
390
391 /** @var Widget_Base $widget */
392 $widget = Plugin::$instance->elements_manager->create_element_instance( $data );
393
394 if ( ! $widget ) {
395 throw new \Exception( 'Widget not found.' );
396 }
397
398 $widget->render_content();
399
400 $render_html = ob_get_clean();
401
402 return $render_html;
403 }
404
405 /**
406 * @since 2.0.0
407 * @access public
408 */
409 public function get_main_post() {
410 return get_post( $this->get_main_id() );
411 }
412
413 public function get_container_attributes() {
414 $id = $this->get_main_id();
415
416 $attributes = [
417 'data-elementor-type' => $this->get_name(),
418 'data-elementor-id' => $id,
419 'class' => 'elementor elementor-' . $id,
420 ];
421
422 $version_meta = $this->get_main_meta( '_elementor_version' );
423
424 if ( version_compare( $version_meta, '2.5.0', '<' ) ) {
425 $attributes['class'] .= ' elementor-bc-flex-widget';
426 }
427
428 if ( Plugin::$instance->preview->is_preview() ) {
429 $attributes['data-elementor-title'] = static::get_title();
430 } else {
431 $elementor_settings = $this->get_frontend_settings();
432 if ( ! empty( $elementor_settings ) ) {
433 $attributes['data-elementor-settings'] = wp_json_encode( $elementor_settings );
434 }
435 }
436
437 // apply this filter to allow the attributes to be modified by different sources
438 return apply_filters( 'elementor/document/wrapper_attributes', $attributes, $this );
439 }
440
441 /**
442 * @since 2.0.0
443 * @access public
444 */
445 public function get_wp_preview_url() {
446 $main_post_id = $this->get_main_id();
447 $document = $this;
448
449 // Ajax request from editor.
450 $initial_document_id = Utils::get_super_global_value( $_POST, 'initial_document_id' ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
451
452 if ( ! empty( $initial_document_id ) ) {
453 $document = Plugin::$instance->documents->get( $initial_document_id ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
454 }
455
456 $url = get_preview_post_link(
457 $document->get_main_id(),
458 [
459 'preview_id' => $main_post_id,
460 'preview_nonce' => wp_create_nonce( 'post_preview_' . $main_post_id ),
461 ]
462 );
463
464 /**
465 * Document "WordPress preview" URL.
466 *
467 * Filters the WordPress preview URL.
468 *
469 * @since 2.0.0
470 *
471 * @param string $url WordPress preview URL.
472 * @param Document $this The document instance.
473 */
474 $url = apply_filters( 'elementor/document/urls/wp_preview', $url, $this );
475
476 return $url;
477 }
478
479 /**
480 * @since 2.0.0
481 * @access public
482 */
483 public function get_exit_to_dashboard_url() {
484 $url = get_edit_post_link( $this->get_main_id(), 'raw' );
485
486 /**
487 * Document "exit to dashboard" URL.
488 *
489 * Filters the "Exit To Dashboard" URL.
490 *
491 * @since 2.0.0
492 *
493 * @param string $url The exit URL
494 * @param Document $this The document instance.
495 */
496 $url = apply_filters( 'elementor/document/urls/exit_to_dashboard', $url, $this );
497
498 return $url;
499 }
500
501 /**
502 * Get All Post Type URL
503 *
504 * Get url of the page which display all the posts of the current active document's post type.
505 *
506 * @since 3.7.0
507 *
508 * @return string $url
509 */
510 public function get_all_post_type_url() {
511 $post_type = get_post_type( $this->get_main_id() );
512
513 $url = get_admin_url() . 'edit.php';
514
515 if ( 'post' !== $post_type ) {
516 $url .= '?post_type=' . $post_type;
517 }
518
519 /**
520 * Document "display all post type" URL.
521 *
522 * @since 3.7.0
523 *
524 * @param string $url The URL.
525 * @param Document $this The document instance.
526 */
527 $url = apply_filters( 'elementor/document/urls/all_post_type', $url, $this );
528
529 return $url;
530 }
531
532 /**
533 * Get Main WP dashboard URL.
534 *
535 * @since 3.7.0
536 *
537 * @return string $url
538 */
539 protected function get_main_dashboard_url() {
540 $url = get_dashboard_url();
541
542 /**
543 * Document "Main Dashboard" URL.
544 *
545 * @since 3.7.0
546 *
547 * @param string $url The URL.
548 * @param Document $this The document instance.
549 */
550 $url = apply_filters( 'elementor/document/urls/main_dashboard', $url, $this );
551
552 return $url;
553 }
554
555 /**
556 * Get auto-saved post revision.
557 *
558 * Retrieve the auto-saved post revision that is newer than current post.
559 *
560 * @since 2.0.0
561 * @access public
562 *
563 * @return bool|Document
564 */
565 public function get_newer_autosave() {
566 $autosave = $this->get_autosave();
567
568 // Detect if there exists an autosave newer than the post.
569 if ( $autosave && mysql2date( 'U', $autosave->get_post()->post_modified_gmt, false ) > mysql2date( 'U', $this->post->post_modified_gmt, false ) ) {
570 return $autosave;
571 }
572
573 return false;
574 }
575
576 /**
577 * @since 2.0.0
578 * @access public
579 */
580 public function is_autosave() {
581 return wp_is_post_autosave( $this->post->ID );
582 }
583
584 /**
585 * Check if the current document is a 'revision'
586 *
587 * @return bool
588 */
589 public function is_revision() {
590 return 'revision' === $this->post->post_type;
591 }
592
593 /**
594 * Checks if the current document status is 'trash'.
595 *
596 * @return bool
597 */
598 public function is_trash() {
599 return 'trash' === $this->post->post_status;
600 }
601
602 /**
603 * @since 2.0.0
604 * @access public
605 *
606 * @param int $user_id
607 * @param bool $create
608 *
609 * @return bool|Document
610 */
611 public function get_autosave( $user_id = 0, $create = false ) {
612 if ( ! $user_id ) {
613 $user_id = get_current_user_id();
614 }
615
616 $autosave_id = $this->get_autosave_id( $user_id );
617
618 if ( $autosave_id ) {
619 $document = Plugin::$instance->documents->get( $autosave_id );
620 } elseif ( $create ) {
621 if ( ! function_exists( 'wp_create_post_autosave' ) ) {
622 require_once ABSPATH . 'wp-admin/includes/post.php';
623 }
624
625 $autosave_id = wp_create_post_autosave( [
626 'post_ID' => $this->post->ID,
627 'post_type' => $this->post->post_type,
628 'post_title' => $this->post->post_title,
629 'post_excerpt' => $this->post->post_excerpt,
630 // Hack to cause $autosave_is_different=true in `wp_create_post_autosave`.
631 'post_content' => '<!-- Created With Elementor -->',
632 'post_modified' => current_time( 'mysql' ),
633 ] );
634
635 Plugin::$instance->db->copy_elementor_meta( $this->post->ID, $autosave_id );
636
637 $document = Plugin::$instance->documents->get( $autosave_id );
638 $document->save_template_type();
639 } else {
640 $document = false;
641 }
642
643 return $document;
644 }
645
646 /**
647 * Add/Remove edit link in dashboard.
648 *
649 * Add or remove an edit link to the post/page action links on the post/pages list table.
650 *
651 * Fired by `post_row_actions` and `page_row_actions` filters.
652 *
653 * @access public
654 *
655 * @param array $actions An array of row action links.
656 *
657 * @return array An updated array of row action links.
658 */
659 public function filter_admin_row_actions( $actions ) {
660 if ( $this->is_editable_with_elementor() ) {
661 $actions['edit_with_elementor'] = sprintf(
662 '<a href="%1$s">%2$s</a>',
663 $this->get_edit_url(),
664 __( 'Edit with Elementor', 'elementor' )
665 );
666 }
667
668 return $actions;
669 }
670
671 public function is_editable_with_elementor() {
672 if ( in_array( $this->get_type(), self::UNEDITABLE_WITH_ELEMENTOR_TYPES ) ) {
673 return false;
674 }
675
676 return $this->is_editable_by_current_user() && $this->is_built_with_elementor();
677 }
678
679 /**
680 * @since 2.0.0
681 * @access public
682 */
683 public function is_editable_by_current_user() {
684 $edit_capability = static::get_property( 'edit_capability' );
685 if ( $edit_capability && ! current_user_can( $edit_capability ) ) {
686 return false;
687 }
688
689 return self::get_property( 'is_editable' ) && User::is_current_user_can_edit( $this->get_main_id() );
690 }
691
692 /**
693 * @since 2.9.0
694 * @access protected
695 */
696 protected function get_initial_config() {
697 // Get document data *after* the scripts hook - so plugins can run compatibility before get data, but *before* enqueue the editor script - so elements can enqueue their own scripts that depended in editor script.
698
699 $locked_user = Plugin::$instance->editor->get_locked_user( $this->get_main_id() );
700
701 if ( $locked_user ) {
702 $locked_user = $locked_user->display_name;
703 }
704
705 $post = $this->get_main_post();
706
707 $post_type_object = get_post_type_object( $post->post_type );
708
709 $settings = SettingsManager::get_settings_managers_config();
710
711 $config = [
712 'id' => $this->get_main_id(),
713 'type' => $this->get_name(),
714 'version' => $this->get_main_meta( '_elementor_version' ),
715 'settings' => $settings['page'],
716 'remoteLibrary' => $this->get_remote_library_config(),
717 'last_edited' => $this->get_last_edited(),
718 'panel' => static::get_editor_panel_config(),
719 'container' => 'body',
720 'post_type_title' => $this->get_post_type_title(),
721 'user' => [
722 'can_publish' => current_user_can( $post_type_object->cap->publish_posts ),
723
724 // Deprecated config since 2.9.0.
725 'locked' => $locked_user,
726 ],
727 'urls' => [
728 'exit_to_dashboard' => $this->get_exit_to_dashboard_url(), // WP post type edit page
729 'all_post_type' => $this->get_all_post_type_url(),
730 'preview' => $this->get_preview_url(),
731 'wp_preview' => $this->get_wp_preview_url(),
732 'permalink' => $this->get_permalink(),
733 'have_a_look' => $this->get_have_a_look_url(),
734 'main_dashboard' => $this->get_main_dashboard_url(),
735 ],
736 ];
737
738 $post_status_object = get_post_status_object( $post->post_status );
739
740 if ( $post_status_object ) {
741 $config['status'] = [
742 'value' => $post_status_object->name,
743 'label' => $post_status_object->label,
744 ];
745 }
746
747 do_action( 'elementor/document/before_get_config', $this );
748
749 if ( static::get_property( 'has_elements' ) ) {
750 $elements_config = Collection::make( Plugin::$instance->elements_manager->get_element_types() )
751 ->filter( fn( $element ) => ( ! empty( $element->get_config()['include_in_widgets_config'] ) ) )
752 ->map( fn( $element ) => $element->get_config() )
753 ->all();
754
755 $config['elements'] = $this->get_elements_raw_data( null, true );
756 // `get_elements_raw_data` has to be called before `get_widget_types_config`, because it affects it.
757 $config['widgets'] = array_merge( $elements_config, Plugin::$instance->widgets_manager->get_widget_types_config() );
758 }
759
760 $additional_config = [];
761
762 /**
763 * Additional document configuration.
764 *
765 * Filters the document configuration by adding additional configuration.
766 * External developers can use this hook to add custom configuration in
767 * addition to Elementor's initial configuration.
768 *
769 * Use the $post_id to add custom configuration for different pages.
770 *
771 * @param array $additional_config The additional document configuration.
772 * @param int $post_id The post ID of the document.
773 */
774 $additional_config = apply_filters( 'elementor/document/config', $additional_config, $this->get_main_id() );
775
776 if ( ! empty( $additional_config ) ) {
777 $config = array_replace_recursive( $config, $additional_config );
778 }
779
780 return $config;
781 }
782
783 /**
784 * @since 3.1.0
785 * @access protected
786 */
787 protected function register_controls() {
788 $this->register_document_controls();
789
790 /**
791 * Register document controls.
792 *
793 * Fires after Elementor registers the document controls.
794 *
795 * External developers can use this hook to add new controls to the document.
796 *
797 * @since 2.0.0
798 *
799 * @param Document $this The document instance.
800 */
801 do_action( 'elementor/documents/register_controls', $this );
802 }
803
804 /**
805 * @since 2.0.0
806 * @access public
807 *
808 * @param $data
809 *
810 * @return bool
811 */
812 public function save( $data ) {
813 /**
814 * Set locale to "C" to avoid issues with comma as decimal separator.
815 *
816 * @see https://github.com/elementor/elementor/issues/10992
817 */
818 $original_lc = setlocale( LC_NUMERIC, 0 );
819 setlocale( LC_NUMERIC, 'C' );
820
821 /**
822 * Document save data.
823 *
824 * Filter the document data before saving process starts.
825 *
826 * External developers can use this hook to change the data before
827 * saving it to the database.
828 *
829 * @since 3.3.0
830 *
831 * @param array $data The document data.
832 * @param \Elementor\Core\Base\Document $this The document instance.
833 */
834 $data = apply_filters( 'elementor/document/save/data', $data, $this );
835
836 $this->add_handle_revisions_changed_filter();
837
838 if ( ! $this->is_editable_by_current_user() ) {
839 return false;
840 }
841
842 $this->set_is_saving( true );
843
844 /**
845 * Before document save.
846 *
847 * Fires when document save starts on Elementor.
848 *
849 * @since 2.5.12
850 *
851 * @param \Elementor\Core\Base\Document $this The current document.
852 * @param $data.
853 */
854 do_action( 'elementor/document/before_save', $this, $data );
855
856 if ( ! current_user_can( 'unfiltered_html' ) ) {
857 $data = map_deep( $data, function ( $value ) {
858 return is_bool( $value ) || is_null( $value ) ? $value : wp_kses_post( $value );
859 } );
860 }
861
862 if ( ! empty( $data['settings'] ) ) {
863 if ( isset( $data['settings']['post_status'] ) && self::STATUS_AUTOSAVE === $data['settings']['post_status'] ) {
864 if ( ! defined( 'DOING_AUTOSAVE' ) ) {
865 define( 'DOING_AUTOSAVE', true );
866 }
867 }
868
869 $this->save_settings( $data['settings'] );
870
871 $this->refresh_post();
872 }
873
874 // Don't check is_empty, because an empty array should be saved.
875 if ( isset( $data['elements'] ) && is_array( $data['elements'] ) ) {
876 $this->save_elements( $data['elements'] );
877 }
878
879 $this->save_template_type();
880
881 $this->save_version();
882
883 // Remove Post CSS
884 $post_css = Post_CSS::create( $this->post->ID );
885
886 $post_css->delete();
887
888 // Remove Document Cache
889 $this->delete_cache();
890
891 /**
892 * After document save.
893 *
894 * Fires when document save is complete.
895 *
896 * @since 2.5.12
897 *
898 * @param \Elementor\Core\Base\Document $this The current document.
899 * @param $data.
900 */
901 do_action( 'elementor/document/after_save', $this, $data );
902
903 $this->set_is_saving( false );
904
905 $this->remove_handle_revisions_changed_filter();
906
907 setlocale( LC_NUMERIC, $original_lc );
908
909 return true;
910 }
911
912 public function refresh_post() {
913 $this->post = get_post( $this->post->ID );
914 }
915
916 /**
917 * @param array $new_settings
918 *
919 * @return static
920 */
921 public function update_settings( array $new_settings ) {
922 $document_settings = $this->get_meta( PageManager::META_KEY );
923
924 if ( ! $document_settings ) {
925 $document_settings = [];
926 }
927
928 $this->save_settings(
929 array_replace_recursive( $document_settings, $new_settings )
930 );
931
932 return $this;
933 }
934
935 /**
936 * Is built with Elementor.
937 *
938 * Check whether the post was built with Elementor.
939 *
940 * @since 2.0.0
941 * @access public
942 *
943 * @return bool Whether the post was built with Elementor.
944 */
945 public function is_built_with_elementor() {
946 return (bool) $this->get_meta( self::BUILT_WITH_ELEMENTOR_META_KEY );
947 }
948
949 /**
950 * Mark the post as "built with elementor" or not.
951 *
952 * @param bool $is_built_with_elementor
953 *
954 * @return $this
955 */
956 public function set_is_built_with_elementor( $is_built_with_elementor ) {
957 if ( $is_built_with_elementor ) {
958 // Use the string `builder` and not a boolean for rollback compatibility
959 $this->update_meta( self::BUILT_WITH_ELEMENTOR_META_KEY, 'builder' );
960 } else {
961 $this->delete_meta( self::BUILT_WITH_ELEMENTOR_META_KEY );
962 }
963
964 return $this;
965 }
966
967 /**
968 * @since 2.0.0
969 * @access public
970 * @static
971 *
972 * @return mixed
973 */
974 public function get_edit_url() {
975 $url = add_query_arg(
976 [
977 'post' => $this->get_main_id(),
978 'action' => 'elementor',
979 ],
980 admin_url( 'post.php' )
981 );
982
983 /**
984 * Document edit url.
985 *
986 * Filters the document edit url.
987 *
988 * @since 2.0.0
989 *
990 * @param string $url The edit url.
991 * @param Document $this The document instance.
992 */
993 $url = apply_filters( 'elementor/document/urls/edit', $url, $this );
994
995 return $url;
996 }
997
998 /**
999 * @since 2.0.0
1000 * @access public
1001 */
1002 public function get_preview_url() {
1003 /**
1004 * Use a static var - to avoid change the `ver` parameter on every call.
1005 */
1006 static $url;
1007
1008 if ( empty( $url ) ) {
1009
1010 add_filter( 'pre_option_permalink_structure', '__return_empty_string' );
1011
1012 $url = set_url_scheme( add_query_arg( [
1013 'elementor-preview' => $this->get_main_id(),
1014 'ver' => time(),
1015 ], $this->get_permalink() ) );
1016
1017 remove_filter( 'pre_option_permalink_structure', '__return_empty_string' );
1018
1019 /**
1020 * Document preview URL.
1021 *
1022 * Filters the document preview URL.
1023 *
1024 * @since 2.0.0
1025 *
1026 * @param string $url The preview URL.
1027 * @param Document $this The document instance.
1028 */
1029 $url = apply_filters( 'elementor/document/urls/preview', $url, $this );
1030 }
1031
1032 return $url;
1033 }
1034
1035 /**
1036 * @since 2.0.0
1037 * @access public
1038 *
1039 * @param string $key
1040 *
1041 * @return array
1042 */
1043 public function get_json_meta( $key ) {
1044 $meta = get_post_meta( $this->post->ID, $key, true );
1045
1046 if ( is_string( $meta ) && ! empty( $meta ) ) {
1047 $meta = json_decode( $meta, true );
1048 }
1049
1050 if ( empty( $meta ) ) {
1051 $meta = [];
1052 }
1053
1054 return $meta;
1055 }
1056
1057 public function update_json_meta( $key, $value ) {
1058 return $this->update_meta(
1059 $key,
1060 // `wp_slash` in order to avoid the unslashing during the `update_post_meta`
1061 wp_slash( wp_json_encode( $value ) )
1062 );
1063 }
1064
1065 /**
1066 * @since 2.0.0
1067 * @access public
1068 *
1069 * @param null $data
1070 * @param bool $with_html_content
1071 *
1072 * @return array
1073 *
1074 * @throws \Exception If elements retrieval fails or data processing errors occur.
1075 */
1076 public function get_elements_raw_data( $data = null, $with_html_content = false ) {
1077 if ( ! static::get_property( 'has_elements' ) ) {
1078 return [];
1079 }
1080
1081 if ( is_null( $data ) ) {
1082 $data = $this->get_elements_data();
1083 }
1084
1085 /**
1086 * Filters document elements data after loading.
1087 *
1088 * Allows modification of elements data when loading (not saving).
1089 * Useful for migrations, transformations, or data enrichment.
1090 *
1091 * @since 3.35.0
1092 *
1093 * @param array $data The elements data array.
1094 * @param \Elementor\Core\Base\Document $document The document instance.
1095 */
1096 if ( ! $this->is_saving ) {
1097 $data = apply_filters( 'elementor/document/load/data', $data, $this );
1098 }
1099
1100 // Change the current documents, so widgets can use `documents->get_current` and other post data
1101 Plugin::$instance->documents->switch_to_document( $this );
1102
1103 $editor_data = [];
1104
1105 foreach ( $data as $element_data ) {
1106 if ( ! is_array( $element_data ) ) {
1107 throw new \Exception( 'Invalid data: ' . wp_json_encode( [
1108 'data' => $data,
1109 'element' => $element_data,
1110 ] ) );
1111 }
1112
1113 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1114
1115 if ( ! $element ) {
1116 continue;
1117 }
1118
1119 if ( $this->is_saving ) {
1120 $element_data = $element->get_data_for_save();
1121 } else {
1122 $element_data = $element->get_raw_data( $with_html_content );
1123 }
1124
1125 $editor_data[] = $element_data;
1126 }
1127
1128 Plugin::$instance->documents->restore_document();
1129
1130 return $editor_data;
1131 }
1132
1133 /**
1134 * @since 2.0.0
1135 * @access public
1136 *
1137 * @param string $status
1138 *
1139 * @return array
1140 */
1141 public function get_elements_data( $status = self::STATUS_PUBLISH ) {
1142 $elements = $this->get_json_meta( self::ELEMENTOR_DATA_META_KEY );
1143
1144 if ( self::STATUS_DRAFT === $status ) {
1145 $autosave = $this->get_newer_autosave();
1146
1147 if ( is_object( $autosave ) ) {
1148 $autosave_elements = Plugin::$instance->documents
1149 ->get( $autosave->get_post()->ID )
1150 ->get_json_meta( self::ELEMENTOR_DATA_META_KEY );
1151 }
1152 }
1153
1154 if ( Plugin::$instance->editor->is_edit_mode() ) {
1155 if ( empty( $elements ) && empty( $autosave_elements ) ) {
1156 // Convert to Elementor.
1157 $elements = $this->convert_to_elementor();
1158 if ( $this->is_autosave() ) {
1159 Plugin::$instance->db->copy_elementor_meta( $this->post->post_parent, $this->post->ID );
1160 }
1161 }
1162 }
1163
1164 if ( ! empty( $autosave_elements ) ) {
1165 $elements = $autosave_elements;
1166 }
1167
1168 return $elements;
1169 }
1170
1171 /**
1172 * Get document setting from DB.
1173 *
1174 * @return array
1175 */
1176 public function get_db_document_settings() {
1177 return $this->get_meta( static::PAGE_META_KEY );
1178 }
1179
1180 /**
1181 * @since 2.3.0
1182 * @access public
1183 */
1184 public function convert_to_elementor() {
1185 $this->save( [] );
1186
1187 if ( empty( $this->post->post_content ) ) {
1188 return [];
1189 }
1190
1191 // Check if it's only a shortcode.
1192 preg_match_all( '/' . get_shortcode_regex() . '/', $this->post->post_content, $matches, PREG_SET_ORDER );
1193 if ( ! empty( $matches ) ) {
1194 foreach ( $matches as $shortcode ) {
1195 if ( trim( $this->post->post_content ) === $shortcode[0] ) {
1196 $widget_type = Plugin::$instance->widgets_manager->get_widget_types( 'shortcode' );
1197 $settings = [
1198 'shortcode' => $this->post->post_content,
1199 ];
1200 break;
1201 }
1202 }
1203 }
1204
1205 if ( empty( $widget_type ) ) {
1206 $widget_type = Plugin::$instance->widgets_manager->get_widget_types( 'text-editor' );
1207 $settings = [
1208 'editor' => $this->post->post_content,
1209 ];
1210 }
1211
1212 // TODO: Better coding to start template for editor
1213 $converted_blocks = [
1214 [
1215 'id' => Utils::generate_random_string(),
1216 'elType' => $widget_type::get_type(),
1217 'widgetType' => $widget_type->get_name(),
1218 'settings' => $settings,
1219 ],
1220 ];
1221
1222 return Plugin::$instance->experiments->is_feature_active( 'container' )
1223 ? $this->get_container_elements_data( $converted_blocks )
1224 : $this->get_sections_elements_data( $converted_blocks );
1225 }
1226
1227 /**
1228 * @since 2.1.3
1229 * @access public
1230 */
1231 public function print_elements_with_wrapper( $elements_data = null ) {
1232 if ( ! $elements_data ) {
1233 $elements_data = $this->get_elements_data();
1234 }
1235
1236 ?>
1237 <div <?php Utils::print_html_attributes( $this->get_container_attributes() ); ?>>
1238 <?php $this->print_elements( $elements_data ); ?>
1239 </div>
1240 <?php
1241 }
1242
1243 /**
1244 * @since 2.0.0
1245 * @access public
1246 */
1247 public function get_css_wrapper_selector() {
1248 return '';
1249 }
1250
1251 /**
1252 * @since 2.0.0
1253 * @access public
1254 */
1255 public function get_panel_page_settings() {
1256 return [
1257 'title' => sprintf(
1258 /* translators: %s: Document title. */
1259 esc_html__( '%s Settings', 'elementor' ),
1260 static::get_title()
1261 ),
1262 ];
1263 }
1264
1265 /**
1266 * @since 2.0.0
1267 * @access public
1268 */
1269 public function get_post() {
1270 return $this->post;
1271 }
1272
1273 /**
1274 * @since 2.0.0
1275 * @access public
1276 */
1277 public function get_permalink() {
1278 return get_permalink( $this->get_main_id() );
1279 }
1280
1281 /**
1282 * @since 2.0.8
1283 * @access public
1284 */
1285 public function get_content( $with_css = false ) {
1286 return Plugin::$instance->frontend->get_builder_content( $this->post->ID, $with_css );
1287 }
1288
1289 /**
1290 * @since 2.0.0
1291 * @access public
1292 */
1293 public function delete() {
1294 if ( 'revision' === $this->post->post_type ) {
1295 $deleted = wp_delete_post_revision( $this->post );
1296 } else {
1297 $deleted = wp_delete_post( $this->post->ID );
1298 }
1299
1300 return $deleted && ! is_wp_error( $deleted );
1301 }
1302
1303 public function force_delete() {
1304 $deleted = wp_delete_post( $this->post->ID, true );
1305
1306 return $deleted && ! is_wp_error( $deleted );
1307 }
1308
1309 /**
1310 * On import update dynamic content (e.g. post and term IDs).
1311 *
1312 * @since 3.8.0
1313 *
1314 * @param array $config The config of the passed element.
1315 * @param array $data The data that requires updating/replacement when imported.
1316 * @param array|null $controls The available controls.
1317 *
1318 * @return array Element data.
1319 */
1320 public static function on_import_update_dynamic_content( array $config, array $data, $controls = null ): array {
1321 foreach ( $config as &$element_config ) {
1322 $element_instance = Plugin::$instance->elements_manager->create_element_instance( $element_config );
1323
1324 if ( is_null( $element_instance ) ) {
1325 continue;
1326 }
1327
1328 if ( $element_instance->has_own_method( 'on_import_replace_dynamic_content' ) ) {
1329 // TODO: Remove this check in the future.
1330 $element_config = $element_instance::on_import_replace_dynamic_content( $element_config, $data['post_ids'] );
1331 } else {
1332 $element_config = $element_instance::on_import_update_dynamic_content( $element_config, $data, $element_instance->get_controls() );
1333 }
1334
1335 $element_config['elements'] = static::on_import_update_dynamic_content( $element_config['elements'], $data );
1336 }
1337
1338 return $config;
1339 }
1340
1341 /**
1342 * Update dynamic settings in the document for import.
1343 *
1344 * @param array $settings The settings of the document.
1345 * @param array $config Import config to update the settings.
1346 *
1347 * @return array
1348 */
1349 public function on_import_update_settings( array $settings, array $config ): array {
1350 $controls = $this->get_controls();
1351 $controls_manager = Plugin::$instance->controls_manager;
1352
1353 foreach ( $settings as $key => $value ) {
1354
1355 if ( ! isset( $controls[ $key ] ) ) {
1356 continue;
1357 }
1358
1359 $control = $controls[ $key ];
1360 $control_instance = $controls_manager->get_control( $control['type'] );
1361
1362 if ( ! $control_instance ) {
1363 continue;
1364 }
1365
1366 $settings[ $key ] = $control_instance->on_import_update_settings( $value, $control, $config );
1367 }
1368
1369 return $settings;
1370 }
1371
1372 /**
1373 * Save editor elements.
1374 *
1375 * Save data from the editor to the database.
1376 *
1377 * @since 2.0.0
1378 * @access protected
1379 *
1380 * @param array $elements
1381 */
1382 protected function save_elements( $elements ) {
1383 $editor_data = $this->get_elements_raw_data( $elements );
1384
1385 // We need the `wp_slash` in order to avoid the unslashing during the `update_post_meta`
1386 $json_value = wp_slash( wp_json_encode( $editor_data ) );
1387
1388 // Don't use `update_post_meta` that can't handle `revision` post type
1389 $is_meta_updated = update_metadata( 'post', $this->post->ID, self::ELEMENTOR_DATA_META_KEY, $json_value );
1390
1391 /**
1392 * Before saving data.
1393 *
1394 * Fires before Elementor saves data to the database.
1395 *
1396 * @since 1.0.0
1397 *
1398 * @param string $status Post status.
1399 * @param int|bool $is_meta_updated Meta ID if the key didn't exist, true on successful update, false on failure.
1400 */
1401 do_action( 'elementor/db/before_save', $this->post->post_status, $is_meta_updated );
1402
1403 Plugin::$instance->db->save_plain_text( $this->post->ID );
1404
1405 $elements_iteration_actions = $this->get_elements_iteration_actions();
1406
1407 if ( $elements_iteration_actions ) {
1408 $this->iterate_elements( $elements, $elements_iteration_actions, 'save' );
1409 }
1410
1411 /**
1412 * After saving data.
1413 *
1414 * Fires after Elementor saves data to the database.
1415 *
1416 * @since 1.0.0
1417 *
1418 * @param int $post_id The ID of the post.
1419 * @param array $editor_data Sanitize posted data.
1420 */
1421 do_action( 'elementor/editor/after_save', $this->post->ID, $editor_data );
1422 }
1423
1424 /**
1425 * @since 2.0.0
1426 * @access public
1427 *
1428 * @param int $user_id Optional. User ID. Default value is `0`.
1429 *
1430 * @return bool|int
1431 */
1432 public function get_autosave_id( $user_id = 0 ) {
1433 if ( ! $user_id ) {
1434 $user_id = get_current_user_id();
1435 }
1436
1437 $autosave = Utils::get_post_autosave( $this->post->ID, $user_id );
1438 if ( $autosave ) {
1439 return $autosave->ID;
1440 }
1441
1442 return false;
1443 }
1444
1445 public function save_version() {
1446 if ( ! defined( 'IS_ELEMENTOR_UPGRADE' ) ) {
1447 // Save per revision.
1448 $this->update_meta( '_elementor_version', ELEMENTOR_VERSION );
1449
1450 /**
1451 * Document version save.
1452 *
1453 * Fires when document version is saved on Elementor.
1454 * Will not fire during Elementor Upgrade.
1455 *
1456 * @since 2.5.12
1457 *
1458 * @param \Elementor\Core\Base\Document $this The current document.
1459 */
1460 do_action( 'elementor/document/save_version', $this );
1461 }
1462 }
1463
1464 /**
1465 * @since 2.3.0
1466 * @access public
1467 */
1468 public function save_template_type() {
1469 return $this->update_main_meta( self::TYPE_META_KEY, $this->get_name() );
1470 }
1471
1472 /**
1473 * @since 2.3.0
1474 * @access public
1475 */
1476 public function get_template_type() {
1477 return $this->get_main_meta( self::TYPE_META_KEY );
1478 }
1479
1480 /**
1481 * @since 2.0.0
1482 * @access public
1483 *
1484 * @param string $key Meta data key.
1485 *
1486 * @return mixed
1487 */
1488 public function get_main_meta( $key ) {
1489 return get_post_meta( $this->get_main_id(), $key, true );
1490 }
1491
1492 /**
1493 * @since 2.0.4
1494 * @access public
1495 *
1496 * @param string $key Meta data key.
1497 * @param mixed $value Meta data value.
1498 *
1499 * @return bool|int
1500 */
1501 public function update_main_meta( $key, $value ) {
1502 return update_post_meta( $this->get_main_id(), $key, $value );
1503 }
1504
1505 /**
1506 * @since 2.0.4
1507 * @access public
1508 *
1509 * @param string $key Meta data key.
1510 * @param string $value Optional. Meta data value. Default is an empty string.
1511 *
1512 * @return bool
1513 */
1514 public function delete_main_meta( $key, $value = '' ) {
1515 return delete_post_meta( $this->get_main_id(), $key, $value );
1516 }
1517
1518 /**
1519 * @since 2.0.0
1520 * @access public
1521 *
1522 * @param string $key Meta data key.
1523 *
1524 * @return mixed
1525 */
1526 public function get_meta( $key ) {
1527 return get_post_meta( $this->post->ID, $key, true );
1528 }
1529
1530 /**
1531 * @since 2.0.0
1532 * @access public
1533 *
1534 * @param string $key Meta data key.
1535 * @param mixed $value Meta data value.
1536 *
1537 * @return bool|int
1538 */
1539 public function update_meta( $key, $value ) {
1540 // Use `update_metadata` in order to work also with revisions.
1541 return update_metadata( 'post', $this->post->ID, $key, $value );
1542 }
1543
1544 /**
1545 * @since 2.0.3
1546 * @access public
1547 *
1548 * @param string $key Meta data key.
1549 * @param string $value Meta data value.
1550 *
1551 * @return bool
1552 */
1553 public function delete_meta( $key, $value = '' ) {
1554 // Use `delete_metadata` in order to work also with revisions.
1555 return delete_metadata( 'post', $this->post->ID, $key, $value );
1556 }
1557
1558 /**
1559 * @since 2.0.0
1560 * @access public
1561 */
1562 public function get_last_edited() {
1563 $post = $this->post;
1564 $autosave_post = $this->get_autosave();
1565
1566 if ( $autosave_post ) {
1567 $post = $autosave_post->get_post();
1568 }
1569
1570 $date = date_i18n( _x( 'M j, H:i', 'revision date format', 'elementor' ), strtotime( $post->post_modified ) );
1571 $display_name = get_the_author_meta( 'display_name', $post->post_author );
1572
1573 if ( $autosave_post || 'revision' === $post->post_type ) {
1574 $last_edited = sprintf(
1575 /* translators: 1: Saving date, 2: Author display name. */
1576 esc_html__( 'Draft saved on %1$s by %2$s', 'elementor' ),
1577 '<time>' . $date . '</time>',
1578 $display_name
1579 );
1580 } else {
1581 $last_edited = sprintf(
1582 /* translators: 1: Editing date, 2: Author display name. */
1583 esc_html__( 'Last edited on %1$s by %2$s', 'elementor' ),
1584 '<time>' . $date . '</time>',
1585 $display_name
1586 );
1587 }
1588
1589 return $last_edited;
1590 }
1591
1592
1593 /**
1594 * @return bool
1595 */
1596 public function is_saving() {
1597 return $this->is_saving;
1598 }
1599
1600 /**
1601 * @param $is_saving
1602 *
1603 * @return $this
1604 */
1605 public function set_is_saving( $is_saving ) {
1606 $this->is_saving = $is_saving;
1607
1608 return $this;
1609 }
1610
1611 /**
1612 * @since 2.0.0
1613 * @access public
1614 *
1615 * @param array $data
1616 *
1617 * @throws \Exception If the post does not exist.
1618 */
1619 public function __construct( array $data = [] ) {
1620 if ( $data ) {
1621 if ( empty( $data['post_id'] ) ) {
1622 $this->post = new \WP_Post( (object) [] );
1623 } else {
1624 $this->post = get_post( $data['post_id'] );
1625
1626 if ( ! $this->post ) {
1627 throw new \Exception( sprintf( 'Post ID #%s does not exist.', esc_html( $data['post_id'] ) ), Exceptions::NOT_FOUND ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
1628 }
1629 }
1630
1631 // Each Control_Stack is based on a unique ID.
1632 $data['id'] = $data['post_id'];
1633
1634 if ( ! isset( $data['settings'] ) ) {
1635 $data['settings'] = [];
1636 }
1637
1638 $saved_settings = get_post_meta( $this->post->ID, '_elementor_page_settings', true );
1639 if ( ! empty( $saved_settings ) && is_array( $saved_settings ) ) {
1640 $data['settings'] += $saved_settings;
1641 }
1642 }
1643
1644 parent::__construct( $data );
1645 }
1646
1647 /**
1648 * Get Export Data
1649 *
1650 * Filters a document's data on export
1651 *
1652 * @since 3.2.0
1653 * @access public
1654 *
1655 * @return array The data to export
1656 */
1657 public function get_export_data() {
1658 $content = Plugin::$instance->db->iterate_data( $this->get_elements_data(), function( $element_data ) {
1659 $element_data['id'] = Utils::generate_random_string();
1660
1661 $element_data = apply_filters( 'elementor/document/element/replace_id', $element_data );
1662
1663 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1664
1665 // If the widget/element does not exist, like a plugin that creates a widget but deactivated.
1666 if ( ! $element ) {
1667 return null;
1668 }
1669
1670 return $this->process_element_import_export( $element, 'on_export' );
1671 } );
1672
1673 return [
1674 'content' => $content,
1675 'settings' => $this->get_data( 'settings' ),
1676 'metadata' => $this->get_export_metadata(),
1677 ];
1678 }
1679
1680 public function get_export_summary() {
1681 return [
1682 'title' => $this->post->post_title,
1683 'doc_type' => $this->get_name(),
1684 'thumbnail' => get_the_post_thumbnail_url( $this->post ),
1685 ];
1686 }
1687
1688 /**
1689 * Get Import Data
1690 *
1691 * Filters a document's data on import
1692 *
1693 * @since 3.2.0
1694 * @access public
1695 *
1696 * @return array The data to import
1697 */
1698 public function get_import_data( array $data ) {
1699 $data['content'] = Plugin::$instance->db->iterate_data( $data['content'], function( $element_data ) {
1700 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1701
1702 // If the widget/element isn't exist, like a plugin that creates a widget but deactivated
1703 if ( ! $element ) {
1704 return null;
1705 }
1706
1707 return $this->process_element_import_export( $element, 'on_import' );
1708 } );
1709
1710 if ( ! empty( $data['settings'] ) ) {
1711 $template_model = new Page_Model( [
1712 'id' => 0,
1713 'settings' => $data['settings'],
1714 ] );
1715
1716 $page_data = $this->process_element_import_export( $template_model, 'on_import' );
1717
1718 $data['settings'] = $page_data['settings'];
1719 }
1720
1721 return $data;
1722 }
1723
1724 /**
1725 * Import
1726 *
1727 * Allows to import an external data to a document
1728 *
1729 * @since 3.2.0
1730 * @access public
1731 *
1732 * @param array $data
1733 */
1734 public function import( array $data ) {
1735 $data = $this->get_import_data( $data );
1736
1737 $this->save( [
1738 'elements' => $data['content'],
1739 'settings' => $data['settings'],
1740 ] );
1741
1742 if ( $data['import_settings']['thumbnail'] ) {
1743 $attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import( [ 'url' => $data['import_settings']['thumbnail'] ] );
1744
1745 set_post_thumbnail( $this->get_main_post(), $attachment['id'] );
1746 }
1747
1748 if ( ! empty( $data['metadata'] ) ) {
1749 foreach ( $data['metadata'] as $key => $value ) {
1750 $this->update_meta( $key, $value );
1751 }
1752 }
1753 }
1754
1755 public function process_element_import_export( Controls_Stack $element, $method, $element_data = null ) {
1756 if ( null === $element_data ) {
1757 $element_data = $element->get_data();
1758 }
1759
1760 if ( method_exists( $element, $method ) ) {
1761 // TODO: Use the internal element data without parameters.
1762 $element_data = $element->{$method}( $element_data );
1763 }
1764
1765 foreach ( $element->get_controls() as $control ) {
1766 $control_class = Plugin::$instance->controls_manager->get_control( $control['type'] );
1767
1768 // If the control isn't exist, like a plugin that creates the control but deactivated.
1769 if ( ! $control_class ) {
1770 return $element_data;
1771 }
1772
1773 // Do not add default value to the final settings, if there is no value at the
1774 // data before the methods `on_import` or `on_export` called.
1775 $has_value = isset( $element_data['settings'][ $control['name'] ] );
1776
1777 if ( $has_value && method_exists( $control_class, $method ) ) {
1778 $element_data['settings'][ $control['name'] ] = $control_class->{$method}(
1779 $element_data['settings'][ $control['name'] ],
1780 $control
1781 );
1782 }
1783
1784 // On Export, check if the control has an argument 'export' => false.
1785 if ( 'on_export' === $method && isset( $control['export'] ) && false === $control['export'] ) {
1786 unset( $element_data['settings'][ $control['name'] ] );
1787 }
1788 }
1789
1790 return $element_data;
1791 }
1792
1793 protected function get_export_metadata() {
1794 $metadata = get_post_meta( $this->get_main_id() );
1795
1796 foreach ( $metadata as $meta_key => $meta_value ) {
1797 if ( is_protected_meta( $meta_key, 'post' ) ) {
1798 unset( $metadata[ $meta_key ] );
1799
1800 continue;
1801 }
1802
1803 $metadata[ $meta_key ] = $meta_value[0];
1804 }
1805
1806 return $metadata;
1807 }
1808
1809 protected function get_remote_library_config() {
1810 $config = [
1811 'type' => 'block',
1812 'default_route' => 'templates/blocks',
1813 'category' => $this->get_name(),
1814 'autoImportSettings' => false,
1815 ];
1816
1817 return $config;
1818 }
1819
1820 /**
1821 * @since 2.0.4
1822 * @access protected
1823 *
1824 * @param $settings
1825 */
1826 protected function save_settings( $settings ) {
1827 $page_settings_manager = SettingsManager::get_settings_managers( 'page' );
1828 $page_settings_manager->ajax_before_save_settings( $settings, $this->post->ID );
1829 $page_settings_manager->save_settings( $settings, $this->post->ID );
1830 }
1831
1832 /**
1833 * @since 2.1.3
1834 * @access public
1835 */
1836 public function print_elements( $elements_data ) {
1837 $is_element_cache_active = 'disable' !== get_option( 'elementor_element_cache_ttl', '' );
1838 if ( ! $is_element_cache_active ) {
1839 ob_start();
1840
1841 $this->do_print_elements( $elements_data );
1842
1843 $content = ob_get_clean();
1844
1845 if ( has_blocks( $content ) ) {
1846 $content = do_blocks( $content );
1847 }
1848
1849 echo $content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1850
1851 return;
1852 }
1853
1854 $cached_data = $this->get_document_cache();
1855
1856 if ( false === $cached_data ) {
1857 add_filter( 'elementor/element/should_render_shortcode', '__return_true' );
1858
1859 $scripts_to_queue = [];
1860 $styles_to_queue = [];
1861
1862 global $wp_scripts, $wp_styles;
1863
1864 $should_store_scripts = $wp_scripts instanceof \WP_Scripts && $wp_styles instanceof \WP_Styles;
1865 if ( $should_store_scripts ) {
1866 $scripts_ignored = $wp_scripts->queue;
1867 $styles_ignored = $wp_styles->queue;
1868 }
1869
1870 ob_start();
1871
1872 $this->do_print_elements( $elements_data );
1873
1874 if ( $should_store_scripts ) {
1875 $scripts_to_queue = array_values( array_diff( $wp_scripts->queue, $scripts_ignored ) );
1876 $styles_to_queue = array_values( array_diff( $wp_styles->queue, $styles_ignored ) );
1877 }
1878
1879 $cached_data = [
1880 'content' => ob_get_clean(),
1881 'scripts' => $scripts_to_queue,
1882 'styles' => $styles_to_queue,
1883 ];
1884
1885 if ( $this->should_store_cache_elements() ) {
1886 $this->set_document_cache( $cached_data );
1887 }
1888
1889 remove_filter( 'elementor/element/should_render_shortcode', '__return_true' );
1890 } else {
1891 if ( ! empty( $cached_data['scripts'] ) ) {
1892 foreach ( $cached_data['scripts'] as $script_handle ) {
1893 wp_enqueue_script( $script_handle );
1894 }
1895 }
1896
1897 if ( ! empty( $cached_data['styles'] ) ) {
1898 foreach ( $cached_data['styles'] as $style_handle ) {
1899 wp_enqueue_style( $style_handle );
1900 }
1901 }
1902 }
1903
1904 if ( ! empty( $cached_data['content'] ) ) {
1905 $content = do_shortcode( $cached_data['content'] );
1906
1907 if ( has_blocks( $content ) ) {
1908 $content = do_blocks( $content );
1909 }
1910
1911 echo $content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1912 }
1913 }
1914
1915 protected function do_print_elements( $elements_data ) {
1916 $this->update_runtime_elements( $elements_data );
1917
1918 foreach ( $elements_data as $element_data ) {
1919 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1920
1921 if ( ! $element ) {
1922 continue;
1923 }
1924
1925 $element->print_element();
1926 }
1927 }
1928
1929 public function update_runtime_elements( $elements_data = null ) {
1930 if ( null === $elements_data ) {
1931 $elements_data = $this->get_elements_data();
1932 }
1933
1934 // Collect all data updaters that should be updated on runtime.
1935 $runtime_elements_iteration_actions = $this->get_runtime_elements_iteration_actions();
1936
1937 if ( $runtime_elements_iteration_actions ) {
1938 $this->iterate_elements( $elements_data, $runtime_elements_iteration_actions, 'render' );
1939 }
1940 }
1941
1942 public function set_document_cache( $value ) {
1943 $expiration_hours = get_option( 'elementor_element_cache_ttl', '' );
1944
1945 if ( empty( $expiration_hours ) || ! is_numeric( $expiration_hours ) ) {
1946 $expiration_hours = '24';
1947 }
1948
1949 $expiration_hours = absint( $expiration_hours );
1950
1951 $expiration = '+' . $expiration_hours . ' hours';
1952
1953 $data = [
1954 'timeout' => strtotime( $expiration, current_time( 'timestamp' ) ),
1955 'value' => $value,
1956 ];
1957
1958 $this->update_json_meta( static::CACHE_META_KEY, $data );
1959 }
1960
1961 private function get_document_cache() {
1962 $cache = $this->get_json_meta( static::CACHE_META_KEY );
1963
1964 if ( empty( $cache['timeout'] ) ) {
1965 return false;
1966 }
1967
1968 if ( current_time( 'timestamp' ) > $cache['timeout'] ) {
1969 return false;
1970 }
1971
1972 if ( ! is_array( $cache['value'] ) ) {
1973 return false;
1974 }
1975
1976 return $cache['value'];
1977 }
1978
1979 protected function delete_cache() {
1980 $this->delete_meta( static::CACHE_META_KEY );
1981 }
1982
1983 private function should_store_cache_elements() {
1984 static $should_store_cache_elements = null;
1985
1986 if ( null === $should_store_cache_elements ) {
1987 $should_store_cache_elements = (
1988 ! is_admin()
1989 && ! Plugin::$instance->preview->is_preview_mode()
1990 );
1991 }
1992
1993 return $should_store_cache_elements;
1994 }
1995
1996 protected function register_document_controls() {
1997 $this->start_controls_section(
1998 'document_settings',
1999 [
2000 'label' => esc_html__( 'General Settings', 'elementor' ),
2001 'tab' => Controls_Manager::TAB_SETTINGS,
2002 ]
2003 );
2004
2005 $this->add_control(
2006 'post_title',
2007 [
2008 'label' => esc_html__( 'Title', 'elementor' ),
2009 'type' => Controls_Manager::TEXT,
2010 'default' => $this->post->post_title,
2011 'label_block' => true,
2012 ]
2013 );
2014
2015 $post_type_object = get_post_type_object( $this->post->post_type );
2016
2017 $can_publish = $post_type_object && current_user_can( $post_type_object->cap->publish_posts );
2018 $is_published = self::STATUS_PUBLISH === $this->post->post_status || self::STATUS_PRIVATE === $this->post->post_status;
2019
2020 if ( $is_published || $can_publish || ! Plugin::$instance->editor->is_edit_mode() ) {
2021
2022 $statuses = $this->get_post_statuses();
2023 if ( 'future' === $this->get_main_post()->post_status ) {
2024 $statuses['future'] = esc_html__( 'Future', 'elementor' );
2025 }
2026
2027 $this->add_control(
2028 'post_status',
2029 [
2030 'label' => esc_html__( 'Status', 'elementor' ),
2031 'type' => Controls_Manager::SELECT,
2032 'default' => $this->get_main_post()->post_status,
2033 'options' => $statuses,
2034 ]
2035 );
2036 }
2037
2038 $this->end_controls_section();
2039 }
2040
2041 protected function get_post_statuses() {
2042 return get_post_statuses();
2043 }
2044
2045 protected function get_have_a_look_url() {
2046 return $this->get_permalink();
2047 }
2048
2049 public function handle_revisions_changed( $post_has_changed, $last_revision, $post ) {
2050 // In case default, didn't determine the changes.
2051 if ( ! $post_has_changed ) {
2052 $last_revision_id = $last_revision->ID;
2053 $last_revision_document = Plugin::instance()->documents->get( $last_revision_id );
2054 $post_document = Plugin::instance()->documents->get( $post->ID );
2055
2056 $last_revision_settings = $last_revision_document->get_settings();
2057 $post_settings = $post_document->get_settings();
2058
2059 // TODO: Its better to add crc32 signature for each revision and then only compare one part of the checksum.
2060 $post_has_changed = $last_revision_settings !== $post_settings;
2061 }
2062
2063 return $post_has_changed;
2064 }
2065
2066 private function add_handle_revisions_changed_filter() {
2067 add_filter( 'wp_save_post_revision_post_has_changed', [ $this, 'handle_revisions_changed' ], 10, 3 );
2068 }
2069
2070 private function remove_handle_revisions_changed_filter() {
2071 remove_filter( 'wp_save_post_revision_post_has_changed', [ $this, 'handle_revisions_changed' ] );
2072 }
2073
2074 private function get_runtime_elements_iteration_actions() {
2075 $runtime_elements_iteration_actions = [];
2076
2077 $elements_iteration_actions = $this->get_elements_iteration_actions();
2078
2079 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2080 if ( $elements_iteration_action->is_action_needed() ) {
2081 $runtime_elements_iteration_actions[] = $elements_iteration_action;
2082 }
2083 }
2084
2085 return $runtime_elements_iteration_actions;
2086 }
2087
2088 private function iterate_elements( $elements, $elements_iteration_actions, $mode ) {
2089 $unique_page_elements = [];
2090
2091 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2092 $elements_iteration_action->set_mode( $mode );
2093 }
2094
2095 Plugin::$instance->db->iterate_data( $elements, function( array $element_data ) use ( &$unique_page_elements, $elements_iteration_actions ) {
2096 $element_type = 'widget' === $element_data['elType'] ? $element_data['widgetType'] : $element_data['elType'];
2097
2098 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
2099
2100 if ( $element ) {
2101 if ( ! in_array( $element_type, $unique_page_elements, true ) ) {
2102 $unique_page_elements[] = $element_type;
2103
2104 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2105 $elements_iteration_action->unique_element_action( $element );
2106 }
2107 }
2108
2109 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2110 $elements_iteration_action->element_action( $element );
2111 }
2112 }
2113
2114 return $element_data;
2115 } );
2116
2117 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2118 $elements_iteration_action->after_elements_iteration();
2119 }
2120 }
2121
2122 private function get_elements_iteration_actions() {
2123 if ( ! $this->elements_iteration_actions ) {
2124 $this->elements_iteration_actions[] = new Assets_Iteration_Action( $this );
2125 }
2126
2127 return $this->elements_iteration_actions;
2128 }
2129
2130 public function get_elementor_version() {
2131 return $this->get_main_meta( '_elementor_version' );
2132 }
2133 }
2134