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

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