PluginProbe
Elementor Website Builder – more than just a page builder / 3.30.3
Elementor Website Builder – more than just a page builder v3.30.3
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 3.30.3, at core/base/document.php

2,102 lines 51.7 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\Exceptions;
10 use Elementor\Includes\Elements\Container;
11 use Elementor\Plugin;
12 use Elementor\Controls_Manager;
13 use Elementor\Controls_Stack;
14 use Elementor\TemplateLibrary\Source_Local;
15 use Elementor\User;
16 use Elementor\Core\Settings\Manager as SettingsManager;
17 use Elementor\Utils;
18 use Elementor\Widget_Base;
19 use Elementor\Core\Settings\Page\Manager as PageManager;
20 use ElementorPro\Modules\Library\Widgets\Template;
21 use Elementor\Core\Utils\Promotions\Filtered_Promotions_Manager;
22 use Elementor\Modules\AtomicWidgets\Module as Atomic_Widgets_Module;
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 $autosave_id = wp_create_post_autosave( [
613 'post_ID' => $this->post->ID,
614 'post_type' => $this->post->post_type,
615 'post_title' => $this->post->post_title,
616 'post_excerpt' => $this->post->post_excerpt,
617 // Hack to cause $autosave_is_different=true in `wp_create_post_autosave`.
618 'post_content' => '<!-- Created With Elementor -->',
619 'post_modified' => current_time( 'mysql' ),
620 ] );
621
622 Plugin::$instance->db->copy_elementor_meta( $this->post->ID, $autosave_id );
623
624 $document = Plugin::$instance->documents->get( $autosave_id );
625 $document->save_template_type();
626 } else {
627 $document = false;
628 }
629
630 return $document;
631 }
632
633 /**
634 * Add/Remove edit link in dashboard.
635 *
636 * Add or remove an edit link to the post/page action links on the post/pages list table.
637 *
638 * Fired by `post_row_actions` and `page_row_actions` filters.
639 *
640 * @access public
641 *
642 * @param array $actions An array of row action links.
643 *
644 * @return array An updated array of row action links.
645 */
646 public function filter_admin_row_actions( $actions ) {
647 if ( $this->is_built_with_elementor() && $this->is_editable_by_current_user() ) {
648 $actions['edit_with_elementor'] = sprintf(
649 '<a href="%1$s">%2$s</a>',
650 $this->get_edit_url(),
651 __( 'Edit with Elementor', 'elementor' )
652 );
653 }
654
655 return $actions;
656 }
657
658 /**
659 * @since 2.0.0
660 * @access public
661 */
662 public function is_editable_by_current_user() {
663 $edit_capability = static::get_property( 'edit_capability' );
664 if ( $edit_capability && ! current_user_can( $edit_capability ) ) {
665 return false;
666 }
667
668 return self::get_property( 'is_editable' ) && User::is_current_user_can_edit( $this->get_main_id() );
669 }
670
671 /**
672 * @since 2.9.0
673 * @access protected
674 */
675 protected function get_initial_config() {
676 // 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.
677
678 $locked_user = Plugin::$instance->editor->get_locked_user( $this->get_main_id() );
679
680 if ( $locked_user ) {
681 $locked_user = $locked_user->display_name;
682 }
683
684 $post = $this->get_main_post();
685
686 $post_type_object = get_post_type_object( $post->post_type );
687
688 $settings = SettingsManager::get_settings_managers_config();
689
690 $config = [
691 'id' => $this->get_main_id(),
692 'type' => $this->get_name(),
693 'version' => $this->get_main_meta( '_elementor_version' ),
694 'settings' => $settings['page'],
695 'remoteLibrary' => $this->get_remote_library_config(),
696 'last_edited' => $this->get_last_edited(),
697 'panel' => static::get_editor_panel_config(),
698 'container' => 'body',
699 'post_type_title' => $this->get_post_type_title(),
700 'user' => [
701 'can_publish' => current_user_can( $post_type_object->cap->publish_posts ),
702
703 // Deprecated config since 2.9.0.
704 'locked' => $locked_user,
705 ],
706 'urls' => [
707 'exit_to_dashboard' => $this->get_exit_to_dashboard_url(), // WP post type edit page
708 'all_post_type' => $this->get_all_post_type_url(),
709 'preview' => $this->get_preview_url(),
710 'wp_preview' => $this->get_wp_preview_url(),
711 'permalink' => $this->get_permalink(),
712 'have_a_look' => $this->get_have_a_look_url(),
713 'main_dashboard' => $this->get_main_dashboard_url(),
714 ],
715 ];
716
717 $post_status_object = get_post_status_object( $post->post_status );
718
719 if ( $post_status_object ) {
720 $config['status'] = [
721 'value' => $post_status_object->name,
722 'label' => $post_status_object->label,
723 ];
724 }
725
726 do_action( 'elementor/document/before_get_config', $this );
727
728 if ( static::get_property( 'has_elements' ) ) {
729 $container_config = [];
730
731 if ( Plugin::$instance->experiments->is_feature_active( 'container' ) ) {
732 $container_config['container'] =
733 Plugin::$instance->elements_manager->get_element_types( 'container' )->get_config();
734 }
735
736 if ( Plugin::$instance->experiments->is_feature_active( Atomic_Widgets_Module::EXPERIMENT_NAME ) ) {
737 // Order reflects the order in the editor.
738 $atomic_elements = [ 'e-flexbox', 'e-div-block' ];
739
740 foreach ( $atomic_elements as $element ) {
741 $container_config[ $element ] = Plugin::$instance->elements_manager->get_element_types( $element )->get_config();
742 }
743 }
744
745 $config['elements'] = $this->get_elements_raw_data( null, true );
746 $config['widgets'] = $container_config + Plugin::$instance->widgets_manager->get_widget_types_config();
747 }
748
749 $additional_config = [];
750
751 /**
752 * Additional document configuration.
753 *
754 * Filters the document configuration by adding additional configuration.
755 * External developers can use this hook to add custom configuration in
756 * addition to Elementor's initial configuration.
757 *
758 * Use the $post_id to add custom configuration for different pages.
759 *
760 * @param array $additional_config The additional document configuration.
761 * @param int $post_id The post ID of the document.
762 */
763 $additional_config = apply_filters( 'elementor/document/config', $additional_config, $this->get_main_id() );
764
765 if ( ! empty( $additional_config ) ) {
766 $config = array_replace_recursive( $config, $additional_config );
767 }
768
769 return $config;
770 }
771
772 /**
773 * @since 3.1.0
774 * @access protected
775 */
776 protected function register_controls() {
777 $this->register_document_controls();
778
779 /**
780 * Register document controls.
781 *
782 * Fires after Elementor registers the document controls.
783 *
784 * External developers can use this hook to add new controls to the document.
785 *
786 * @since 2.0.0
787 *
788 * @param Document $this The document instance.
789 */
790 do_action( 'elementor/documents/register_controls', $this );
791 }
792
793 /**
794 * @since 2.0.0
795 * @access public
796 *
797 * @param $data
798 *
799 * @return bool
800 */
801 public function save( $data ) {
802 /**
803 * Set locale to "C" to avoid issues with comma as decimal separator.
804 *
805 * @see https://github.com/elementor/elementor/issues/10992
806 */
807 $original_lc = setlocale( LC_NUMERIC, 0 );
808 setlocale( LC_NUMERIC, 'C' );
809
810 /**
811 * Document save data.
812 *
813 * Filter the document data before saving process starts.
814 *
815 * External developers can use this hook to change the data before
816 * saving it to the database.
817 *
818 * @since 3.3.0
819 *
820 * @param array $data The document data.
821 * @param \Elementor\Core\Base\Document $this The document instance.
822 */
823 $data = apply_filters( 'elementor/document/save/data', $data, $this );
824
825 $this->add_handle_revisions_changed_filter();
826
827 if ( ! $this->is_editable_by_current_user() ) {
828 return false;
829 }
830
831 $this->set_is_saving( true );
832
833 /**
834 * Before document save.
835 *
836 * Fires when document save starts on Elementor.
837 *
838 * @since 2.5.12
839 *
840 * @param \Elementor\Core\Base\Document $this The current document.
841 * @param $data.
842 */
843 do_action( 'elementor/document/before_save', $this, $data );
844
845 if ( ! current_user_can( 'unfiltered_html' ) ) {
846 $data = map_deep( $data, function ( $value ) {
847 return is_bool( $value ) || is_null( $value ) ? $value : wp_kses_post( $value );
848 } );
849 }
850
851 if ( ! empty( $data['settings'] ) ) {
852 if ( isset( $data['settings']['post_status'] ) && self::STATUS_AUTOSAVE === $data['settings']['post_status'] ) {
853 if ( ! defined( 'DOING_AUTOSAVE' ) ) {
854 define( 'DOING_AUTOSAVE', true );
855 }
856 }
857
858 $this->save_settings( $data['settings'] );
859
860 $this->refresh_post();
861 }
862
863 // Don't check is_empty, because an empty array should be saved.
864 if ( isset( $data['elements'] ) && is_array( $data['elements'] ) ) {
865 $this->save_elements( $data['elements'] );
866 }
867
868 $this->save_template_type();
869
870 $this->save_version();
871
872 // Remove Post CSS
873 $post_css = Post_CSS::create( $this->post->ID );
874
875 $post_css->delete();
876
877 // Remove Document Cache
878 $this->delete_cache();
879
880 /**
881 * After document save.
882 *
883 * Fires when document save is complete.
884 *
885 * @since 2.5.12
886 *
887 * @param \Elementor\Core\Base\Document $this The current document.
888 * @param $data.
889 */
890 do_action( 'elementor/document/after_save', $this, $data );
891
892 $this->set_is_saving( false );
893
894 $this->remove_handle_revisions_changed_filter();
895
896 setlocale( LC_NUMERIC, $original_lc );
897
898 return true;
899 }
900
901 public function refresh_post() {
902 $this->post = get_post( $this->post->ID );
903 }
904
905 /**
906 * @param array $new_settings
907 *
908 * @return static
909 */
910 public function update_settings( array $new_settings ) {
911 $document_settings = $this->get_meta( PageManager::META_KEY );
912
913 if ( ! $document_settings ) {
914 $document_settings = [];
915 }
916
917 $this->save_settings(
918 array_replace_recursive( $document_settings, $new_settings )
919 );
920
921 return $this;
922 }
923
924 /**
925 * Is built with Elementor.
926 *
927 * Check whether the post was built with Elementor.
928 *
929 * @since 2.0.0
930 * @access public
931 *
932 * @return bool Whether the post was built with Elementor.
933 */
934 public function is_built_with_elementor() {
935 return (bool) $this->get_meta( self::BUILT_WITH_ELEMENTOR_META_KEY );
936 }
937
938 /**
939 * Mark the post as "built with elementor" or not.
940 *
941 * @param bool $is_built_with_elementor
942 *
943 * @return $this
944 */
945 public function set_is_built_with_elementor( $is_built_with_elementor ) {
946 if ( $is_built_with_elementor ) {
947 // Use the string `builder` and not a boolean for rollback compatibility
948 $this->update_meta( self::BUILT_WITH_ELEMENTOR_META_KEY, 'builder' );
949 } else {
950 $this->delete_meta( self::BUILT_WITH_ELEMENTOR_META_KEY );
951 }
952
953 return $this;
954 }
955
956 /**
957 * @since 2.0.0
958 * @access public
959 * @static
960 *
961 * @return mixed
962 */
963 public function get_edit_url() {
964 $url = add_query_arg(
965 [
966 'post' => $this->get_main_id(),
967 'action' => 'elementor',
968 ],
969 admin_url( 'post.php' )
970 );
971
972 /**
973 * Document edit url.
974 *
975 * Filters the document edit url.
976 *
977 * @since 2.0.0
978 *
979 * @param string $url The edit url.
980 * @param Document $this The document instance.
981 */
982 $url = apply_filters( 'elementor/document/urls/edit', $url, $this );
983
984 return $url;
985 }
986
987 /**
988 * @since 2.0.0
989 * @access public
990 */
991 public function get_preview_url() {
992 /**
993 * Use a static var - to avoid change the `ver` parameter on every call.
994 */
995 static $url;
996
997 if ( empty( $url ) ) {
998
999 add_filter( 'pre_option_permalink_structure', '__return_empty_string' );
1000
1001 $url = set_url_scheme( add_query_arg( [
1002 'elementor-preview' => $this->get_main_id(),
1003 'ver' => time(),
1004 ], $this->get_permalink() ) );
1005
1006 remove_filter( 'pre_option_permalink_structure', '__return_empty_string' );
1007
1008 /**
1009 * Document preview URL.
1010 *
1011 * Filters the document preview URL.
1012 *
1013 * @since 2.0.0
1014 *
1015 * @param string $url The preview URL.
1016 * @param Document $this The document instance.
1017 */
1018 $url = apply_filters( 'elementor/document/urls/preview', $url, $this );
1019 }
1020
1021 return $url;
1022 }
1023
1024 /**
1025 * @since 2.0.0
1026 * @access public
1027 *
1028 * @param string $key
1029 *
1030 * @return array
1031 */
1032 public function get_json_meta( $key ) {
1033 $meta = get_post_meta( $this->post->ID, $key, true );
1034
1035 if ( is_string( $meta ) && ! empty( $meta ) ) {
1036 $meta = json_decode( $meta, true );
1037 }
1038
1039 if ( empty( $meta ) ) {
1040 $meta = [];
1041 }
1042
1043 return $meta;
1044 }
1045
1046 public function update_json_meta( $key, $value ) {
1047 return $this->update_meta(
1048 $key,
1049 // `wp_slash` in order to avoid the unslashing during the `update_post_meta`
1050 wp_slash( wp_json_encode( $value ) )
1051 );
1052 }
1053
1054 /**
1055 * @since 2.0.0
1056 * @access public
1057 *
1058 * @param null $data
1059 * @param bool $with_html_content
1060 *
1061 * @return array
1062 */
1063 public function get_elements_raw_data( $data = null, $with_html_content = false ) {
1064 if ( ! static::get_property( 'has_elements' ) ) {
1065 return [];
1066 }
1067
1068 if ( is_null( $data ) ) {
1069 $data = $this->get_elements_data();
1070 }
1071
1072 // Change the current documents, so widgets can use `documents->get_current` and other post data
1073 Plugin::$instance->documents->switch_to_document( $this );
1074
1075 $editor_data = [];
1076
1077 foreach ( $data as $element_data ) {
1078 if ( ! is_array( $element_data ) ) {
1079 throw new \Exception( 'Invalid data: ' . wp_json_encode( [
1080 'data' => $data,
1081 'element' => $element_data,
1082 ] ) );
1083 }
1084
1085 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1086
1087 if ( ! $element ) {
1088 continue;
1089 }
1090
1091 if ( $this->is_saving ) {
1092 $element_data = $element->get_data_for_save();
1093 } else {
1094 $element_data = $element->get_raw_data( $with_html_content );
1095 }
1096
1097 $editor_data[] = $element_data;
1098 }
1099
1100 Plugin::$instance->documents->restore_document();
1101
1102 return $editor_data;
1103 }
1104
1105 /**
1106 * @since 2.0.0
1107 * @access public
1108 *
1109 * @param string $status
1110 *
1111 * @return array
1112 */
1113 public function get_elements_data( $status = self::STATUS_PUBLISH ) {
1114 $elements = $this->get_json_meta( self::ELEMENTOR_DATA_META_KEY );
1115
1116 if ( self::STATUS_DRAFT === $status ) {
1117 $autosave = $this->get_newer_autosave();
1118
1119 if ( is_object( $autosave ) ) {
1120 $autosave_elements = Plugin::$instance->documents
1121 ->get( $autosave->get_post()->ID )
1122 ->get_json_meta( self::ELEMENTOR_DATA_META_KEY );
1123 }
1124 }
1125
1126 if ( Plugin::$instance->editor->is_edit_mode() ) {
1127 if ( empty( $elements ) && empty( $autosave_elements ) ) {
1128 // Convert to Elementor.
1129 $elements = $this->convert_to_elementor();
1130 if ( $this->is_autosave() ) {
1131 Plugin::$instance->db->copy_elementor_meta( $this->post->post_parent, $this->post->ID );
1132 }
1133 }
1134 }
1135
1136 if ( ! empty( $autosave_elements ) ) {
1137 $elements = $autosave_elements;
1138 }
1139
1140 return $elements;
1141 }
1142
1143 /**
1144 * Get document setting from DB.
1145 *
1146 * @return array
1147 */
1148 public function get_db_document_settings() {
1149 return $this->get_meta( static::PAGE_META_KEY );
1150 }
1151
1152 /**
1153 * @since 2.3.0
1154 * @access public
1155 */
1156 public function convert_to_elementor() {
1157 $this->save( [] );
1158
1159 if ( empty( $this->post->post_content ) ) {
1160 return [];
1161 }
1162
1163 // Check if it's only a shortcode.
1164 preg_match_all( '/' . get_shortcode_regex() . '/', $this->post->post_content, $matches, PREG_SET_ORDER );
1165 if ( ! empty( $matches ) ) {
1166 foreach ( $matches as $shortcode ) {
1167 if ( trim( $this->post->post_content ) === $shortcode[0] ) {
1168 $widget_type = Plugin::$instance->widgets_manager->get_widget_types( 'shortcode' );
1169 $settings = [
1170 'shortcode' => $this->post->post_content,
1171 ];
1172 break;
1173 }
1174 }
1175 }
1176
1177 if ( empty( $widget_type ) ) {
1178 $widget_type = Plugin::$instance->widgets_manager->get_widget_types( 'text-editor' );
1179 $settings = [
1180 'editor' => $this->post->post_content,
1181 ];
1182 }
1183
1184 // TODO: Better coding to start template for editor
1185 $converted_blocks = [
1186 [
1187 'id' => Utils::generate_random_string(),
1188 'elType' => $widget_type::get_type(),
1189 'widgetType' => $widget_type->get_name(),
1190 'settings' => $settings,
1191 ],
1192 ];
1193
1194 return Plugin::$instance->experiments->is_feature_active( 'container' )
1195 ? $this->get_container_elements_data( $converted_blocks )
1196 : $this->get_sections_elements_data( $converted_blocks );
1197 }
1198
1199 /**
1200 * @since 2.1.3
1201 * @access public
1202 */
1203 public function print_elements_with_wrapper( $elements_data = null ) {
1204 if ( ! $elements_data ) {
1205 $elements_data = $this->get_elements_data();
1206 }
1207
1208 ?>
1209 <div <?php Utils::print_html_attributes( $this->get_container_attributes() ); ?>>
1210 <?php $this->print_elements( $elements_data ); ?>
1211 </div>
1212 <?php
1213 }
1214
1215 /**
1216 * @since 2.0.0
1217 * @access public
1218 */
1219 public function get_css_wrapper_selector() {
1220 return '';
1221 }
1222
1223 /**
1224 * @since 2.0.0
1225 * @access public
1226 */
1227 public function get_panel_page_settings() {
1228 return [
1229 'title' => sprintf(
1230 /* translators: %s: Document title. */
1231 esc_html__( '%s Settings', 'elementor' ),
1232 static::get_title()
1233 ),
1234 ];
1235 }
1236
1237 /**
1238 * @since 2.0.0
1239 * @access public
1240 */
1241 public function get_post() {
1242 return $this->post;
1243 }
1244
1245 /**
1246 * @since 2.0.0
1247 * @access public
1248 */
1249 public function get_permalink() {
1250 return get_permalink( $this->get_main_id() );
1251 }
1252
1253 /**
1254 * @since 2.0.8
1255 * @access public
1256 */
1257 public function get_content( $with_css = false ) {
1258 return Plugin::$instance->frontend->get_builder_content( $this->post->ID, $with_css );
1259 }
1260
1261 /**
1262 * @since 2.0.0
1263 * @access public
1264 */
1265 public function delete() {
1266 if ( 'revision' === $this->post->post_type ) {
1267 $deleted = wp_delete_post_revision( $this->post );
1268 } else {
1269 $deleted = wp_delete_post( $this->post->ID );
1270 }
1271
1272 return $deleted && ! is_wp_error( $deleted );
1273 }
1274
1275 public function force_delete() {
1276 $deleted = wp_delete_post( $this->post->ID, true );
1277
1278 return $deleted && ! is_wp_error( $deleted );
1279 }
1280
1281 /**
1282 * On import update dynamic content (e.g. post and term IDs).
1283 *
1284 * @since 3.8.0
1285 *
1286 * @param array $config The config of the passed element.
1287 * @param array $data The data that requires updating/replacement when imported.
1288 * @param array|null $controls The available controls.
1289 *
1290 * @return array Element data.
1291 */
1292 public static function on_import_update_dynamic_content( array $config, array $data, $controls = null ): array {
1293 foreach ( $config as &$element_config ) {
1294 $element_instance = Plugin::$instance->elements_manager->create_element_instance( $element_config );
1295
1296 if ( is_null( $element_instance ) ) {
1297 continue;
1298 }
1299
1300 if ( $element_instance->has_own_method( 'on_import_replace_dynamic_content' ) ) {
1301 // TODO: Remove this check in the future.
1302 $element_config = $element_instance::on_import_replace_dynamic_content( $element_config, $data['post_ids'] );
1303 } else {
1304 $element_config = $element_instance::on_import_update_dynamic_content( $element_config, $data, $element_instance->get_controls() );
1305 }
1306
1307 $element_config['elements'] = static::on_import_update_dynamic_content( $element_config['elements'], $data );
1308 }
1309
1310 return $config;
1311 }
1312
1313 /**
1314 * Update dynamic settings in the document for import.
1315 *
1316 * @param array $settings The settings of the document.
1317 * @param array $config Import config to update the settings.
1318 *
1319 * @return array
1320 */
1321 public function on_import_update_settings( array $settings, array $config ): array {
1322 $controls = $this->get_controls();
1323 $controls_manager = Plugin::$instance->controls_manager;
1324
1325 foreach ( $settings as $key => $value ) {
1326
1327 if ( ! isset( $controls[ $key ] ) ) {
1328 continue;
1329 }
1330
1331 $control = $controls[ $key ];
1332 $control_instance = $controls_manager->get_control( $control['type'] );
1333
1334 if ( ! $control_instance ) {
1335 continue;
1336 }
1337
1338 $settings[ $key ] = $control_instance->on_import_update_settings( $value, $control, $config );
1339 }
1340
1341 return $settings;
1342 }
1343
1344 /**
1345 * Save editor elements.
1346 *
1347 * Save data from the editor to the database.
1348 *
1349 * @since 2.0.0
1350 * @access protected
1351 *
1352 * @param array $elements
1353 */
1354 protected function save_elements( $elements ) {
1355 $editor_data = $this->get_elements_raw_data( $elements );
1356
1357 // We need the `wp_slash` in order to avoid the unslashing during the `update_post_meta`
1358 $json_value = wp_slash( wp_json_encode( $editor_data ) );
1359
1360 // Don't use `update_post_meta` that can't handle `revision` post type
1361 $is_meta_updated = update_metadata( 'post', $this->post->ID, self::ELEMENTOR_DATA_META_KEY, $json_value );
1362
1363 /**
1364 * Before saving data.
1365 *
1366 * Fires before Elementor saves data to the database.
1367 *
1368 * @since 1.0.0
1369 *
1370 * @param string $status Post status.
1371 * @param int|bool $is_meta_updated Meta ID if the key didn't exist, true on successful update, false on failure.
1372 */
1373 do_action( 'elementor/db/before_save', $this->post->post_status, $is_meta_updated );
1374
1375 Plugin::$instance->db->save_plain_text( $this->post->ID );
1376
1377 $elements_iteration_actions = $this->get_elements_iteration_actions();
1378
1379 if ( $elements_iteration_actions ) {
1380 $this->iterate_elements( $elements, $elements_iteration_actions, 'save' );
1381 }
1382
1383 /**
1384 * After saving data.
1385 *
1386 * Fires after Elementor saves data to the database.
1387 *
1388 * @since 1.0.0
1389 *
1390 * @param int $post_id The ID of the post.
1391 * @param array $editor_data Sanitize posted data.
1392 */
1393 do_action( 'elementor/editor/after_save', $this->post->ID, $editor_data );
1394 }
1395
1396 /**
1397 * @since 2.0.0
1398 * @access public
1399 *
1400 * @param int $user_id Optional. User ID. Default value is `0`.
1401 *
1402 * @return bool|int
1403 */
1404 public function get_autosave_id( $user_id = 0 ) {
1405 if ( ! $user_id ) {
1406 $user_id = get_current_user_id();
1407 }
1408
1409 $autosave = Utils::get_post_autosave( $this->post->ID, $user_id );
1410 if ( $autosave ) {
1411 return $autosave->ID;
1412 }
1413
1414 return false;
1415 }
1416
1417 public function save_version() {
1418 if ( ! defined( 'IS_ELEMENTOR_UPGRADE' ) ) {
1419 // Save per revision.
1420 $this->update_meta( '_elementor_version', ELEMENTOR_VERSION );
1421
1422 /**
1423 * Document version save.
1424 *
1425 * Fires when document version is saved on Elementor.
1426 * Will not fire during Elementor Upgrade.
1427 *
1428 * @since 2.5.12
1429 *
1430 * @param \Elementor\Core\Base\Document $this The current document.
1431 */
1432 do_action( 'elementor/document/save_version', $this );
1433 }
1434 }
1435
1436 /**
1437 * @since 2.3.0
1438 * @access public
1439 */
1440 public function save_template_type() {
1441 return $this->update_main_meta( self::TYPE_META_KEY, $this->get_name() );
1442 }
1443
1444 /**
1445 * @since 2.3.0
1446 * @access public
1447 */
1448 public function get_template_type() {
1449 return $this->get_main_meta( self::TYPE_META_KEY );
1450 }
1451
1452 /**
1453 * @since 2.0.0
1454 * @access public
1455 *
1456 * @param string $key Meta data key.
1457 *
1458 * @return mixed
1459 */
1460 public function get_main_meta( $key ) {
1461 return get_post_meta( $this->get_main_id(), $key, true );
1462 }
1463
1464 /**
1465 * @since 2.0.4
1466 * @access public
1467 *
1468 * @param string $key Meta data key.
1469 * @param mixed $value Meta data value.
1470 *
1471 * @return bool|int
1472 */
1473 public function update_main_meta( $key, $value ) {
1474 return update_post_meta( $this->get_main_id(), $key, $value );
1475 }
1476
1477 /**
1478 * @since 2.0.4
1479 * @access public
1480 *
1481 * @param string $key Meta data key.
1482 * @param string $value Optional. Meta data value. Default is an empty string.
1483 *
1484 * @return bool
1485 */
1486 public function delete_main_meta( $key, $value = '' ) {
1487 return delete_post_meta( $this->get_main_id(), $key, $value );
1488 }
1489
1490 /**
1491 * @since 2.0.0
1492 * @access public
1493 *
1494 * @param string $key Meta data key.
1495 *
1496 * @return mixed
1497 */
1498 public function get_meta( $key ) {
1499 return get_post_meta( $this->post->ID, $key, true );
1500 }
1501
1502 /**
1503 * @since 2.0.0
1504 * @access public
1505 *
1506 * @param string $key Meta data key.
1507 * @param mixed $value Meta data value.
1508 *
1509 * @return bool|int
1510 */
1511 public function update_meta( $key, $value ) {
1512 // Use `update_metadata` in order to work also with revisions.
1513 return update_metadata( 'post', $this->post->ID, $key, $value );
1514 }
1515
1516 /**
1517 * @since 2.0.3
1518 * @access public
1519 *
1520 * @param string $key Meta data key.
1521 * @param string $value Meta data value.
1522 *
1523 * @return bool
1524 */
1525 public function delete_meta( $key, $value = '' ) {
1526 // Use `delete_metadata` in order to work also with revisions.
1527 return delete_metadata( 'post', $this->post->ID, $key, $value );
1528 }
1529
1530 /**
1531 * @since 2.0.0
1532 * @access public
1533 */
1534 public function get_last_edited() {
1535 $post = $this->post;
1536 $autosave_post = $this->get_autosave();
1537
1538 if ( $autosave_post ) {
1539 $post = $autosave_post->get_post();
1540 }
1541
1542 $date = date_i18n( _x( 'M j, H:i', 'revision date format', 'elementor' ), strtotime( $post->post_modified ) );
1543 $display_name = get_the_author_meta( 'display_name', $post->post_author );
1544
1545 if ( $autosave_post || 'revision' === $post->post_type ) {
1546 $last_edited = sprintf(
1547 /* translators: 1: Saving date, 2: Author display name. */
1548 esc_html__( 'Draft saved on %1$s by %2$s', 'elementor' ),
1549 '<time>' . $date . '</time>',
1550 $display_name
1551 );
1552 } else {
1553 $last_edited = sprintf(
1554 /* translators: 1: Editing date, 2: Author display name. */
1555 esc_html__( 'Last edited on %1$s by %2$s', 'elementor' ),
1556 '<time>' . $date . '</time>',
1557 $display_name
1558 );
1559 }
1560
1561 return $last_edited;
1562 }
1563
1564
1565 /**
1566 * @return bool
1567 */
1568 public function is_saving() {
1569 return $this->is_saving;
1570 }
1571
1572 /**
1573 * @param $is_saving
1574 *
1575 * @return $this
1576 */
1577 public function set_is_saving( $is_saving ) {
1578 $this->is_saving = $is_saving;
1579
1580 return $this;
1581 }
1582
1583 /**
1584 * @since 2.0.0
1585 * @access public
1586 *
1587 * @param array $data
1588 *
1589 * @throws \Exception If the post does not exist.
1590 */
1591 public function __construct( array $data = [] ) {
1592 if ( $data ) {
1593 if ( empty( $data['post_id'] ) ) {
1594 $this->post = new \WP_Post( (object) [] );
1595 } else {
1596 $this->post = get_post( $data['post_id'] );
1597
1598 if ( ! $this->post ) {
1599 throw new \Exception( sprintf( 'Post ID #%s does not exist.', esc_html( $data['post_id'] ) ), Exceptions::NOT_FOUND ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
1600 }
1601 }
1602
1603 // Each Control_Stack is based on a unique ID.
1604 $data['id'] = $data['post_id'];
1605
1606 if ( ! isset( $data['settings'] ) ) {
1607 $data['settings'] = [];
1608 }
1609
1610 $saved_settings = get_post_meta( $this->post->ID, '_elementor_page_settings', true );
1611 if ( ! empty( $saved_settings ) && is_array( $saved_settings ) ) {
1612 $data['settings'] += $saved_settings;
1613 }
1614 }
1615
1616 parent::__construct( $data );
1617 }
1618
1619 /**
1620 * Get Export Data
1621 *
1622 * Filters a document's data on export
1623 *
1624 * @since 3.2.0
1625 * @access public
1626 *
1627 * @return array The data to export
1628 */
1629 public function get_export_data() {
1630 $content = Plugin::$instance->db->iterate_data( $this->get_elements_data(), function( $element_data ) {
1631 $element_data['id'] = Utils::generate_random_string();
1632
1633 $element_data = apply_filters( 'elementor/document/element/replace_id', $element_data );
1634
1635 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1636
1637 // If the widget/element does not exist, like a plugin that creates a widget but deactivated.
1638 if ( ! $element ) {
1639 return null;
1640 }
1641
1642 return $this->process_element_import_export( $element, 'on_export' );
1643 } );
1644
1645 return [
1646 'content' => $content,
1647 'settings' => $this->get_data( 'settings' ),
1648 'metadata' => $this->get_export_metadata(),
1649 ];
1650 }
1651
1652 public function get_export_summary() {
1653 return [
1654 'title' => $this->post->post_title,
1655 'doc_type' => $this->get_name(),
1656 'thumbnail' => get_the_post_thumbnail_url( $this->post ),
1657 ];
1658 }
1659
1660 /**
1661 * Get Import Data
1662 *
1663 * Filters a document's data on import
1664 *
1665 * @since 3.2.0
1666 * @access public
1667 *
1668 * @return array The data to import
1669 */
1670 public function get_import_data( array $data ) {
1671 $data['content'] = Plugin::$instance->db->iterate_data( $data['content'], function( $element_data ) {
1672 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1673
1674 // If the widget/element isn't exist, like a plugin that creates a widget but deactivated
1675 if ( ! $element ) {
1676 return null;
1677 }
1678
1679 return $this->process_element_import_export( $element, 'on_import' );
1680 } );
1681
1682 if ( ! empty( $data['settings'] ) ) {
1683 $template_model = new Page_Model( [
1684 'id' => 0,
1685 'settings' => $data['settings'],
1686 ] );
1687
1688 $page_data = $this->process_element_import_export( $template_model, 'on_import' );
1689
1690 $data['settings'] = $page_data['settings'];
1691 }
1692
1693 return $data;
1694 }
1695
1696 /**
1697 * Import
1698 *
1699 * Allows to import an external data to a document
1700 *
1701 * @since 3.2.0
1702 * @access public
1703 *
1704 * @param array $data
1705 */
1706 public function import( array $data ) {
1707 $data = $this->get_import_data( $data );
1708
1709 $this->save( [
1710 'elements' => $data['content'],
1711 'settings' => $data['settings'],
1712 ] );
1713
1714 if ( $data['import_settings']['thumbnail'] ) {
1715 $attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import( [ 'url' => $data['import_settings']['thumbnail'] ] );
1716
1717 set_post_thumbnail( $this->get_main_post(), $attachment['id'] );
1718 }
1719
1720 if ( ! empty( $data['metadata'] ) ) {
1721 foreach ( $data['metadata'] as $key => $value ) {
1722 $this->update_meta( $key, $value );
1723 }
1724 }
1725 }
1726
1727 public function process_element_import_export( Controls_Stack $element, $method, $element_data = null ) {
1728 if ( null === $element_data ) {
1729 $element_data = $element->get_data();
1730 }
1731
1732 if ( method_exists( $element, $method ) ) {
1733 // TODO: Use the internal element data without parameters.
1734 $element_data = $element->{$method}( $element_data );
1735 }
1736
1737 foreach ( $element->get_controls() as $control ) {
1738 $control_class = Plugin::$instance->controls_manager->get_control( $control['type'] );
1739
1740 // If the control isn't exist, like a plugin that creates the control but deactivated.
1741 if ( ! $control_class ) {
1742 return $element_data;
1743 }
1744
1745 // Do not add default value to the final settings, if there is no value at the
1746 // data before the methods `on_import` or `on_export` called.
1747 $has_value = isset( $element_data['settings'][ $control['name'] ] );
1748
1749 if ( $has_value && method_exists( $control_class, $method ) ) {
1750 $element_data['settings'][ $control['name'] ] = $control_class->{$method}(
1751 $element_data['settings'][ $control['name'] ],
1752 $control
1753 );
1754 }
1755
1756 // On Export, check if the control has an argument 'export' => false.
1757 if ( 'on_export' === $method && isset( $control['export'] ) && false === $control['export'] ) {
1758 unset( $element_data['settings'][ $control['name'] ] );
1759 }
1760 }
1761
1762 return $element_data;
1763 }
1764
1765 protected function get_export_metadata() {
1766 $metadata = get_post_meta( $this->get_main_id() );
1767
1768 foreach ( $metadata as $meta_key => $meta_value ) {
1769 if ( is_protected_meta( $meta_key, 'post' ) ) {
1770 unset( $metadata[ $meta_key ] );
1771
1772 continue;
1773 }
1774
1775 $metadata[ $meta_key ] = $meta_value[0];
1776 }
1777
1778 return $metadata;
1779 }
1780
1781 protected function get_remote_library_config() {
1782 $config = [
1783 'type' => 'block',
1784 'default_route' => 'templates/blocks',
1785 'category' => $this->get_name(),
1786 'autoImportSettings' => false,
1787 ];
1788
1789 return $config;
1790 }
1791
1792 /**
1793 * @since 2.0.4
1794 * @access protected
1795 *
1796 * @param $settings
1797 */
1798 protected function save_settings( $settings ) {
1799 $page_settings_manager = SettingsManager::get_settings_managers( 'page' );
1800 $page_settings_manager->ajax_before_save_settings( $settings, $this->post->ID );
1801 $page_settings_manager->save_settings( $settings, $this->post->ID );
1802 }
1803
1804 /**
1805 * @since 2.1.3
1806 * @access protected
1807 */
1808 protected function print_elements( $elements_data ) {
1809 $is_element_cache_active = Plugin::$instance->experiments->is_feature_active( 'e_element_cache' ) && 'disable' !== get_option( 'elementor_element_cache_ttl', '' );
1810 if ( ! $is_element_cache_active ) {
1811 ob_start();
1812
1813 $this->do_print_elements( $elements_data );
1814
1815 $content = ob_get_clean();
1816
1817 if ( has_blocks( $content ) ) {
1818 $content = do_blocks( $content );
1819 }
1820
1821 echo $content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1822
1823 return;
1824 }
1825
1826 $cached_data = $this->get_document_cache();
1827
1828 if ( false === $cached_data ) {
1829 add_filter( 'elementor/element/should_render_shortcode', '__return_true' );
1830
1831 $scripts_to_queue = [];
1832 $styles_to_queue = [];
1833
1834 global $wp_scripts, $wp_styles;
1835
1836 $should_store_scripts = $wp_scripts instanceof \WP_Scripts && $wp_styles instanceof \WP_Styles;
1837 if ( $should_store_scripts ) {
1838 $scripts_ignored = $wp_scripts->queue;
1839 $styles_ignored = $wp_styles->queue;
1840 }
1841
1842 ob_start();
1843
1844 $this->do_print_elements( $elements_data );
1845
1846 if ( $should_store_scripts ) {
1847 $scripts_to_queue = array_values( array_diff( $wp_scripts->queue, $scripts_ignored ) );
1848 $styles_to_queue = array_values( array_diff( $wp_styles->queue, $styles_ignored ) );
1849 }
1850
1851 $cached_data = [
1852 'content' => ob_get_clean(),
1853 'scripts' => $scripts_to_queue,
1854 'styles' => $styles_to_queue,
1855 ];
1856
1857 if ( $this->should_store_cache_elements() ) {
1858 $this->set_document_cache( $cached_data );
1859 }
1860
1861 remove_filter( 'elementor/element/should_render_shortcode', '__return_true' );
1862 } else {
1863 if ( ! empty( $cached_data['scripts'] ) ) {
1864 foreach ( $cached_data['scripts'] as $script_handle ) {
1865 wp_enqueue_script( $script_handle );
1866 }
1867 }
1868
1869 if ( ! empty( $cached_data['styles'] ) ) {
1870 foreach ( $cached_data['styles'] as $style_handle ) {
1871 wp_enqueue_style( $style_handle );
1872 }
1873 }
1874 }
1875
1876 if ( ! empty( $cached_data['content'] ) ) {
1877 $content = do_shortcode( $cached_data['content'] );
1878
1879 if ( has_blocks( $content ) ) {
1880 $content = do_blocks( $content );
1881 }
1882
1883 echo $content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1884 }
1885 }
1886
1887 protected function do_print_elements( $elements_data ) {
1888 $this->update_runtime_elements( $elements_data );
1889
1890 foreach ( $elements_data as $element_data ) {
1891 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1892
1893 if ( ! $element ) {
1894 continue;
1895 }
1896
1897 $element->print_element();
1898 }
1899 }
1900
1901 public function update_runtime_elements( $elements_data = null ) {
1902 if ( null === $elements_data ) {
1903 $elements_data = $this->get_elements_data();
1904 }
1905
1906 // Collect all data updaters that should be updated on runtime.
1907 $runtime_elements_iteration_actions = $this->get_runtime_elements_iteration_actions();
1908
1909 if ( $runtime_elements_iteration_actions ) {
1910 $this->iterate_elements( $elements_data, $runtime_elements_iteration_actions, 'render' );
1911 }
1912 }
1913
1914 public function set_document_cache( $value ) {
1915 $expiration_hours = get_option( 'elementor_element_cache_ttl', '' );
1916
1917 if ( empty( $expiration_hours ) || ! is_numeric( $expiration_hours ) ) {
1918 $expiration_hours = '24';
1919 }
1920
1921 $expiration_hours = absint( $expiration_hours );
1922
1923 $expiration = '+' . $expiration_hours . ' hours';
1924
1925 $data = [
1926 'timeout' => strtotime( $expiration, current_time( 'timestamp' ) ),
1927 'value' => $value,
1928 ];
1929
1930 $this->update_json_meta( static::CACHE_META_KEY, $data );
1931 }
1932
1933 private function get_document_cache() {
1934 $cache = $this->get_json_meta( static::CACHE_META_KEY );
1935
1936 if ( empty( $cache['timeout'] ) ) {
1937 return false;
1938 }
1939
1940 if ( current_time( 'timestamp' ) > $cache['timeout'] ) {
1941 return false;
1942 }
1943
1944 if ( ! is_array( $cache['value'] ) ) {
1945 return false;
1946 }
1947
1948 return $cache['value'];
1949 }
1950
1951 protected function delete_cache() {
1952 $this->delete_meta( static::CACHE_META_KEY );
1953 }
1954
1955 private function should_store_cache_elements() {
1956 static $should_store_cache_elements = null;
1957
1958 if ( null === $should_store_cache_elements ) {
1959 $should_store_cache_elements = (
1960 ! is_admin()
1961 && ! Plugin::$instance->preview->is_preview_mode()
1962 );
1963 }
1964
1965 return $should_store_cache_elements;
1966 }
1967
1968 protected function register_document_controls() {
1969 $this->start_controls_section(
1970 'document_settings',
1971 [
1972 'label' => esc_html__( 'General Settings', 'elementor' ),
1973 'tab' => Controls_Manager::TAB_SETTINGS,
1974 ]
1975 );
1976
1977 $this->add_control(
1978 'post_title',
1979 [
1980 'label' => esc_html__( 'Title', 'elementor' ),
1981 'type' => Controls_Manager::TEXT,
1982 'default' => $this->post->post_title,
1983 'label_block' => true,
1984 ]
1985 );
1986
1987 $post_type_object = get_post_type_object( $this->post->post_type );
1988
1989 $can_publish = $post_type_object && current_user_can( $post_type_object->cap->publish_posts );
1990 $is_published = self::STATUS_PUBLISH === $this->post->post_status || self::STATUS_PRIVATE === $this->post->post_status;
1991
1992 if ( $is_published || $can_publish || ! Plugin::$instance->editor->is_edit_mode() ) {
1993
1994 $statuses = $this->get_post_statuses();
1995 if ( 'future' === $this->get_main_post()->post_status ) {
1996 $statuses['future'] = esc_html__( 'Future', 'elementor' );
1997 }
1998
1999 $this->add_control(
2000 'post_status',
2001 [
2002 'label' => esc_html__( 'Status', 'elementor' ),
2003 'type' => Controls_Manager::SELECT,
2004 'default' => $this->get_main_post()->post_status,
2005 'options' => $statuses,
2006 ]
2007 );
2008 }
2009
2010 $this->end_controls_section();
2011 }
2012
2013 protected function get_post_statuses() {
2014 return get_post_statuses();
2015 }
2016
2017 protected function get_have_a_look_url() {
2018 return $this->get_permalink();
2019 }
2020
2021 public function handle_revisions_changed( $post_has_changed, $last_revision, $post ) {
2022 // In case default, didn't determine the changes.
2023 if ( ! $post_has_changed ) {
2024 $last_revision_id = $last_revision->ID;
2025 $last_revision_document = Plugin::instance()->documents->get( $last_revision_id );
2026 $post_document = Plugin::instance()->documents->get( $post->ID );
2027
2028 $last_revision_settings = $last_revision_document->get_settings();
2029 $post_settings = $post_document->get_settings();
2030
2031 // TODO: Its better to add crc32 signature for each revision and then only compare one part of the checksum.
2032 $post_has_changed = $last_revision_settings !== $post_settings;
2033 }
2034
2035 return $post_has_changed;
2036 }
2037
2038 private function add_handle_revisions_changed_filter() {
2039 add_filter( 'wp_save_post_revision_post_has_changed', [ $this, 'handle_revisions_changed' ], 10, 3 );
2040 }
2041
2042 private function remove_handle_revisions_changed_filter() {
2043 remove_filter( 'wp_save_post_revision_post_has_changed', [ $this, 'handle_revisions_changed' ] );
2044 }
2045
2046 private function get_runtime_elements_iteration_actions() {
2047 $runtime_elements_iteration_actions = [];
2048
2049 $elements_iteration_actions = $this->get_elements_iteration_actions();
2050
2051 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2052 if ( $elements_iteration_action->is_action_needed() ) {
2053 $runtime_elements_iteration_actions[] = $elements_iteration_action;
2054 }
2055 }
2056
2057 return $runtime_elements_iteration_actions;
2058 }
2059
2060 private function iterate_elements( $elements, $elements_iteration_actions, $mode ) {
2061 $unique_page_elements = [];
2062
2063 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2064 $elements_iteration_action->set_mode( $mode );
2065 }
2066
2067 Plugin::$instance->db->iterate_data( $elements, function( array $element_data ) use ( &$unique_page_elements, $elements_iteration_actions ) {
2068 $element_type = 'widget' === $element_data['elType'] ? $element_data['widgetType'] : $element_data['elType'];
2069
2070 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
2071
2072 if ( $element ) {
2073 if ( ! in_array( $element_type, $unique_page_elements, true ) ) {
2074 $unique_page_elements[] = $element_type;
2075
2076 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2077 $elements_iteration_action->unique_element_action( $element );
2078 }
2079 }
2080
2081 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2082 $elements_iteration_action->element_action( $element );
2083 }
2084 }
2085
2086 return $element_data;
2087 } );
2088
2089 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2090 $elements_iteration_action->after_elements_iteration();
2091 }
2092 }
2093
2094 private function get_elements_iteration_actions() {
2095 if ( ! $this->elements_iteration_actions ) {
2096 $this->elements_iteration_actions[] = new Assets_Iteration_Action( $this );
2097 }
2098
2099 return $this->elements_iteration_actions;
2100 }
2101 }
2102