PluginProbe
Elementor Website Builder – more than just a page builder / 4.0.0-dev2
Elementor Website Builder – more than just a page builder v4.0.0-dev2
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.0.0-dev2, at core/base/document.php

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