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

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