PluginProbe
Elementor Website Builder – more than just a page builder / 3.32.0-dev2
Elementor Website Builder – more than just a page builder v3.32.0-dev2
4.3.0-beta2 4.3.0-beta1 4.2.4 4.2.3 4.2.2 4.2.1 4.2.0 4.1.5 4.2.0-beta2 4.2.0-dev2 4.2.0-beta1 4.1.4 4.1.3 4.1.2 4.1.1 4.1.0 4.1.0-beta3 4.1.0-dev3 4.0.9 4.1.0-beta2 4.1.0-dev2 4.0.8 4.1.0-beta1 4.1.0-dev1 4.0.7 All 451 releases
elementor / core / base / document.php

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

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