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

2,067 lines 50.4 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 $experiments_manager = Plugin::$instance->experiments;
731
732 if ( $experiments_manager->is_feature_active( 'container' ) ) {
733 $container_config = [
734 'container' => Plugin::$instance->elements_manager->get_element_types( 'container' )->get_config(),
735 ];
736 }
737
738 $config['elements'] = $this->get_elements_raw_data( null, true );
739 $config['widgets'] = $container_config + Plugin::$instance->widgets_manager->get_widget_types_config();
740 }
741
742 $additional_config = [];
743
744 /**
745 * Additional document configuration.
746 *
747 * Filters the document configuration by adding additional configuration.
748 * External developers can use this hook to add custom configuration in
749 * addition to Elementor's initial configuration.
750 *
751 * Use the $post_id to add custom configuration for different pages.
752 *
753 * @param array $additional_config The additional document configuration.
754 * @param int $post_id The post ID of the document.
755 */
756 $additional_config = apply_filters( 'elementor/document/config', $additional_config, $this->get_main_id() );
757
758 if ( ! empty( $additional_config ) ) {
759 $config = array_replace_recursive( $config, $additional_config );
760 }
761
762 return $config;
763 }
764
765 /**
766 * @since 3.1.0
767 * @access protected
768 */
769 protected function register_controls() {
770 $this->register_document_controls();
771
772 /**
773 * Register document controls.
774 *
775 * Fires after Elementor registers the document controls.
776 *
777 * External developers can use this hook to add new controls to the document.
778 *
779 * @since 2.0.0
780 *
781 * @param Document $this The document instance.
782 */
783 do_action( 'elementor/documents/register_controls', $this );
784 }
785
786 /**
787 * @since 2.0.0
788 * @access public
789 *
790 * @param $data
791 *
792 * @return bool
793 */
794 public function save( $data ) {
795 /**
796 * Set locale to "C" to avoid issues with comma as decimal separator.
797 *
798 * @see https://github.com/elementor/elementor/issues/10992
799 */
800 $original_lc = setlocale( LC_NUMERIC, 0 );
801 setlocale( LC_NUMERIC, 'C' );
802
803 /**
804 * Document save data.
805 *
806 * Filter the document data before saving process starts.
807 *
808 * External developers can use this hook to change the data before
809 * saving it to the database.
810 *
811 * @since 3.3.0
812 *
813 * @param array $data The document data.
814 * @param \Elementor\Core\Base\Document $this The document instance.
815 */
816 $data = apply_filters( 'elementor/document/save/data', $data, $this );
817
818 $this->add_handle_revisions_changed_filter();
819
820 if ( ! $this->is_editable_by_current_user() ) {
821 return false;
822 }
823
824 $this->set_is_saving( true );
825
826 /**
827 * Before document save.
828 *
829 * Fires when document save starts on Elementor.
830 *
831 * @since 2.5.12
832 *
833 * @param \Elementor\Core\Base\Document $this The current document.
834 * @param $data.
835 */
836 do_action( 'elementor/document/before_save', $this, $data );
837
838 if ( ! current_user_can( 'unfiltered_html' ) ) {
839 $data = wp_kses_post_deep( $data );
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 ! ! $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 $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 } // End foreach().
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( '_elementor_data' );
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( '_elementor_data' );
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, '_elementor_data', $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 */
1424 do_action( 'elementor/document/save_version', $this );
1425 }
1426 }
1427
1428 /**
1429 * @since 2.3.0
1430 * @access public
1431 */
1432 public function save_template_type() {
1433 return $this->update_main_meta( self::TYPE_META_KEY, $this->get_name() );
1434 }
1435
1436 /**
1437 * @since 2.3.0
1438 * @access public
1439 */
1440 public function get_template_type() {
1441 return $this->get_main_meta( self::TYPE_META_KEY );
1442 }
1443
1444 /**
1445 * @since 2.0.0
1446 * @access public
1447 *
1448 * @param string $key Meta data key.
1449 *
1450 * @return mixed
1451 */
1452 public function get_main_meta( $key ) {
1453 return get_post_meta( $this->get_main_id(), $key, true );
1454 }
1455
1456 /**
1457 * @since 2.0.4
1458 * @access public
1459 *
1460 * @param string $key Meta data key.
1461 * @param mixed $value Meta data value.
1462 *
1463 * @return bool|int
1464 */
1465 public function update_main_meta( $key, $value ) {
1466 return update_post_meta( $this->get_main_id(), $key, $value );
1467 }
1468
1469 /**
1470 * @since 2.0.4
1471 * @access public
1472 *
1473 * @param string $key Meta data key.
1474 * @param string $value Optional. Meta data value. Default is an empty string.
1475 *
1476 * @return bool
1477 */
1478 public function delete_main_meta( $key, $value = '' ) {
1479 return delete_post_meta( $this->get_main_id(), $key, $value );
1480 }
1481
1482 /**
1483 * @since 2.0.0
1484 * @access public
1485 *
1486 * @param string $key Meta data key.
1487 *
1488 * @return mixed
1489 */
1490 public function get_meta( $key ) {
1491 return get_post_meta( $this->post->ID, $key, true );
1492 }
1493
1494 /**
1495 * @since 2.0.0
1496 * @access public
1497 *
1498 * @param string $key Meta data key.
1499 * @param mixed $value Meta data value.
1500 *
1501 * @return bool|int
1502 */
1503 public function update_meta( $key, $value ) {
1504 // Use `update_metadata` in order to work also with revisions.
1505 return update_metadata( 'post', $this->post->ID, $key, $value );
1506 }
1507
1508 /**
1509 * @since 2.0.3
1510 * @access public
1511 *
1512 * @param string $key Meta data key.
1513 * @param string $value Meta data value.
1514 *
1515 * @return bool
1516 */
1517 public function delete_meta( $key, $value = '' ) {
1518 // Use `delete_metadata` in order to work also with revisions.
1519 return delete_metadata( 'post', $this->post->ID, $key, $value );
1520 }
1521
1522 /**
1523 * @since 2.0.0
1524 * @access public
1525 */
1526 public function get_last_edited() {
1527 $post = $this->post;
1528 $autosave_post = $this->get_autosave();
1529
1530 if ( $autosave_post ) {
1531 $post = $autosave_post->get_post();
1532 }
1533
1534 $date = date_i18n( _x( 'M j, H:i', 'revision date format', 'elementor' ), strtotime( $post->post_modified ) );
1535 $display_name = get_the_author_meta( 'display_name', $post->post_author );
1536
1537 if ( $autosave_post || 'revision' === $post->post_type ) {
1538 $last_edited = sprintf(
1539 /* translators: 1: Saving date, 2: Author display name. */
1540 esc_html__( 'Draft saved on %1$s by %2$s', 'elementor' ),
1541 '<time>' . $date . '</time>',
1542 $display_name
1543 );
1544 } else {
1545 $last_edited = sprintf(
1546 /* translators: 1: Editing date, 2: Author display name. */
1547 esc_html__( 'Last edited on %1$s by %2$s', 'elementor' ),
1548 '<time>' . $date . '</time>',
1549 $display_name
1550 );
1551 }
1552
1553 return $last_edited;
1554 }
1555
1556
1557 /**
1558 * @return bool
1559 */
1560 public function is_saving() {
1561 return $this->is_saving;
1562 }
1563
1564 /**
1565 * @param $is_saving
1566 *
1567 * @return $this
1568 */
1569 public function set_is_saving( $is_saving ) {
1570 $this->is_saving = $is_saving;
1571
1572 return $this;
1573 }
1574
1575 /**
1576 * @since 2.0.0
1577 * @access public
1578 *
1579 * @param array $data
1580 *
1581 * @throws \Exception If the post does not exist.
1582 */
1583 public function __construct( array $data = [] ) {
1584 if ( $data ) {
1585 if ( empty( $data['post_id'] ) ) {
1586 $this->post = new \WP_Post( (object) [] );
1587 } else {
1588 $this->post = get_post( $data['post_id'] );
1589
1590 if ( ! $this->post ) {
1591 throw new \Exception( sprintf( 'Post ID #%s does not exist.', $data['post_id'] ), Exceptions::NOT_FOUND );
1592 }
1593 }
1594
1595 // Each Control_Stack is based on a unique ID.
1596 $data['id'] = $data['post_id'];
1597
1598 if ( ! isset( $data['settings'] ) ) {
1599 $data['settings'] = [];
1600 }
1601
1602 $saved_settings = get_post_meta( $this->post->ID, '_elementor_page_settings', true );
1603 if ( ! empty( $saved_settings ) && is_array( $saved_settings ) ) {
1604 $data['settings'] += $saved_settings;
1605 }
1606 }
1607
1608 parent::__construct( $data );
1609 }
1610
1611 /*
1612 * Get Export Data
1613 *
1614 * Filters a document's data on export
1615 *
1616 * @since 3.2.0
1617 * @access public
1618 *
1619 * @return array The data to export
1620 */
1621 public function get_export_data() {
1622 $content = Plugin::$instance->db->iterate_data( $this->get_elements_data(), function( $element_data ) {
1623 $element_data['id'] = Utils::generate_random_string();
1624
1625 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1626
1627 // If the widget/element does not exist, like a plugin that creates a widget but deactivated.
1628 if ( ! $element ) {
1629 return null;
1630 }
1631
1632 return $this->process_element_import_export( $element, 'on_export' );
1633 } );
1634
1635 return [
1636 'content' => $content,
1637 'settings' => $this->get_data( 'settings' ),
1638 'metadata' => $this->get_export_metadata(),
1639 ];
1640 }
1641
1642 public function get_export_summary() {
1643 return [
1644 'title' => $this->post->post_title,
1645 'doc_type' => $this->get_name(),
1646 'thumbnail' => get_the_post_thumbnail_url( $this->post ),
1647 ];
1648 }
1649
1650 /*
1651 * Get Import Data
1652 *
1653 * Filters a document's data on import
1654 *
1655 * @since 3.2.0
1656 * @access public
1657 *
1658 * @return array The data to import
1659 */
1660 public function get_import_data( array $data ) {
1661 $data['content'] = Plugin::$instance->db->iterate_data( $data['content'], function( $element_data ) {
1662 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1663
1664 // If the widget/element isn't exist, like a plugin that creates a widget but deactivated
1665 if ( ! $element ) {
1666 return null;
1667 }
1668
1669 return $this->process_element_import_export( $element, 'on_import' );
1670 } );
1671
1672 if ( ! empty( $data['settings'] ) ) {
1673 $template_model = new Page_Model( [
1674 'id' => 0,
1675 'settings' => $data['settings'],
1676 ] );
1677
1678 $page_data = $this->process_element_import_export( $template_model, 'on_import' );
1679
1680 $data['settings'] = $page_data['settings'];
1681 }
1682
1683 return $data;
1684 }
1685
1686 /**
1687 * Import
1688 *
1689 * Allows to import an external data to a document
1690 *
1691 * @since 3.2.0
1692 * @access public
1693 *
1694 * @param array $data
1695 */
1696 public function import( array $data ) {
1697 $data = $this->get_import_data( $data );
1698
1699 $this->save( [
1700 'elements' => $data['content'],
1701 'settings' => $data['settings'],
1702 ] );
1703
1704 if ( $data['import_settings']['thumbnail'] ) {
1705 $attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import( [ 'url' => $data['import_settings']['thumbnail'] ] );
1706
1707 set_post_thumbnail( $this->get_main_post(), $attachment['id'] );
1708 }
1709
1710 if ( ! empty( $data['metadata'] ) ) {
1711 foreach ( $data['metadata'] as $key => $value ) {
1712 $this->update_meta( $key, $value );
1713 }
1714 }
1715 }
1716
1717 public function process_element_import_export( Controls_Stack $element, $method, $element_data = null ) {
1718 if ( null === $element_data ) {
1719 $element_data = $element->get_data();
1720 }
1721
1722 if ( method_exists( $element, $method ) ) {
1723 // TODO: Use the internal element data without parameters.
1724 $element_data = $element->{$method}( $element_data );
1725 }
1726
1727 foreach ( $element->get_controls() as $control ) {
1728 $control_class = Plugin::$instance->controls_manager->get_control( $control['type'] );
1729
1730 // If the control isn't exist, like a plugin that creates the control but deactivated.
1731 if ( ! $control_class ) {
1732 return $element_data;
1733 }
1734
1735 // Do not add default value to the final settings, if there is no value at the
1736 // data before the methods `on_import` or `on_export` called.
1737 $has_value = isset( $element_data['settings'][ $control['name'] ] );
1738
1739 if ( $has_value && method_exists( $control_class, $method ) ) {
1740 $element_data['settings'][ $control['name'] ] = $control_class->{$method}(
1741 $element_data['settings'][ $control['name'] ],
1742 $control
1743 );
1744 }
1745
1746 // On Export, check if the control has an argument 'export' => false.
1747 if ( 'on_export' === $method && isset( $control['export'] ) && false === $control['export'] ) {
1748 unset( $element_data['settings'][ $control['name'] ] );
1749 }
1750 }
1751
1752 return $element_data;
1753 }
1754
1755 protected function get_export_metadata() {
1756 $metadata = get_post_meta( $this->get_main_id() );
1757
1758 foreach ( $metadata as $meta_key => $meta_value ) {
1759 if ( is_protected_meta( $meta_key, 'post' ) ) {
1760 unset( $metadata[ $meta_key ] );
1761
1762 continue;
1763 }
1764
1765 $metadata[ $meta_key ] = $meta_value[0];
1766 }
1767
1768 return $metadata;
1769 }
1770
1771 protected function get_remote_library_config() {
1772 $config = [
1773 'type' => 'block',
1774 'default_route' => 'templates/blocks',
1775 'category' => $this->get_name(),
1776 'autoImportSettings' => false,
1777 ];
1778
1779 return $config;
1780 }
1781
1782 /**
1783 * @since 2.0.4
1784 * @access protected
1785 *
1786 * @param $settings
1787 */
1788 protected function save_settings( $settings ) {
1789 $page_settings_manager = SettingsManager::get_settings_managers( 'page' );
1790 $page_settings_manager->ajax_before_save_settings( $settings, $this->post->ID );
1791 $page_settings_manager->save_settings( $settings, $this->post->ID );
1792 }
1793
1794 /**
1795 * @since 2.1.3
1796 * @access protected
1797 */
1798 protected function print_elements( $elements_data ) {
1799 if ( ! Plugin::$instance->experiments->is_feature_active( 'e_element_cache' ) ) {
1800 $this->do_print_elements( $elements_data );
1801
1802 return;
1803 }
1804
1805 $cached_data = $this->get_document_cache();
1806
1807 if ( false === $cached_data ) {
1808 add_filter( 'elementor/element/should_render_shortcode', '__return_true' );
1809
1810 $scripts_to_queue = [];
1811 $styles_to_queue = [];
1812
1813 global $wp_scripts, $wp_styles;
1814
1815 $should_store_scripts = $wp_scripts instanceof \WP_Scripts && $wp_styles instanceof \WP_Styles;
1816 if ( $should_store_scripts ) {
1817 $scripts_ignored = $wp_scripts->queue;
1818 $styles_ignored = $wp_styles->queue;
1819 }
1820
1821 ob_start();
1822
1823 $this->do_print_elements( $elements_data );
1824
1825 if ( $should_store_scripts ) {
1826 $scripts_to_queue = array_values( array_diff( $wp_scripts->queue, $scripts_ignored ) );
1827 $styles_to_queue = array_values( array_diff( $wp_styles->queue, $styles_ignored ) );
1828 }
1829
1830 $cached_data = [
1831 'content' => ob_get_clean(),
1832 'scripts' => $scripts_to_queue,
1833 'styles' => $styles_to_queue,
1834 ];
1835
1836 if ( $this->should_store_cache_elements() ) {
1837 $this->set_document_cache( $cached_data );
1838 }
1839
1840 remove_filter( 'elementor/element/should_render_shortcode', '__return_true' );
1841 } else {
1842 if ( ! empty( $cached_data['scripts'] ) ) {
1843 foreach ( $cached_data['scripts'] as $script_handle ) {
1844 wp_enqueue_script( $script_handle );
1845 }
1846 }
1847
1848 if ( ! empty( $cached_data['styles'] ) ) {
1849 foreach ( $cached_data['styles'] as $style_handle ) {
1850 wp_enqueue_style( $style_handle );
1851 }
1852 }
1853 }
1854
1855 if ( ! empty( $cached_data['content'] ) ) {
1856 echo do_shortcode( $cached_data['content'] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1857 }
1858 }
1859
1860 protected function do_print_elements( $elements_data ) {
1861 // Collect all data updaters that should be updated on runtime.
1862 $runtime_elements_iteration_actions = $this->get_runtime_elements_iteration_actions();
1863
1864 if ( $runtime_elements_iteration_actions ) {
1865 $this->iterate_elements( $elements_data, $runtime_elements_iteration_actions, 'render' );
1866 }
1867
1868 foreach ( $elements_data as $element_data ) {
1869 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
1870
1871 if ( ! $element ) {
1872 continue;
1873 }
1874
1875 $element->print_element();
1876 }
1877 }
1878
1879 public function set_document_cache( $value ) {
1880 $expiration_hours = get_option( 'elementor_element_cache_ttl', '' );
1881
1882 if ( empty( $expiration_hours ) || ! is_numeric( $expiration_hours ) ) {
1883 $expiration_hours = '24';
1884 }
1885
1886 $expiration_hours = absint( $expiration_hours );
1887
1888 $expiration = '+' . $expiration_hours . ' hours';
1889
1890 $data = [
1891 'timeout' => strtotime( $expiration, current_time( 'timestamp' ) ),
1892 'value' => $value,
1893 ];
1894
1895 $this->update_json_meta( static::CACHE_META_KEY, $data );
1896 }
1897
1898 private function get_document_cache() {
1899 $cache = $this->get_json_meta( static::CACHE_META_KEY );
1900
1901 if ( empty( $cache['timeout'] ) ) {
1902 return false;
1903 }
1904
1905 if ( current_time( 'timestamp' ) > $cache['timeout'] ) {
1906 return false;
1907 }
1908
1909 if ( ! is_array( $cache['value'] ) ) {
1910 return false;
1911 }
1912
1913 return $cache['value'];
1914 }
1915
1916 protected function delete_cache() {
1917 $this->delete_meta( static::CACHE_META_KEY );
1918 }
1919
1920 private function should_store_cache_elements() {
1921 static $should_store_cache_elements = null;
1922
1923 if ( null === $should_store_cache_elements ) {
1924 $should_store_cache_elements = (
1925 ! is_admin()
1926 && ! Plugin::$instance->preview->is_preview_mode()
1927 );
1928 }
1929
1930 return $should_store_cache_elements;
1931 }
1932
1933 protected function register_document_controls() {
1934 $this->start_controls_section(
1935 'document_settings',
1936 [
1937 'label' => esc_html__( 'General Settings', 'elementor' ),
1938 'tab' => Controls_Manager::TAB_SETTINGS,
1939 ]
1940 );
1941
1942 $this->add_control(
1943 'post_title',
1944 [
1945 'label' => esc_html__( 'Title', 'elementor' ),
1946 'type' => Controls_Manager::TEXT,
1947 'default' => $this->post->post_title,
1948 'label_block' => true,
1949 ]
1950 );
1951
1952 $post_type_object = get_post_type_object( $this->post->post_type );
1953
1954 $can_publish = $post_type_object && current_user_can( $post_type_object->cap->publish_posts );
1955 $is_published = self::STATUS_PUBLISH === $this->post->post_status || self::STATUS_PRIVATE === $this->post->post_status;
1956
1957 if ( $is_published || $can_publish || ! Plugin::$instance->editor->is_edit_mode() ) {
1958
1959 $statuses = $this->get_post_statuses();
1960 if ( 'future' === $this->get_main_post()->post_status ) {
1961 $statuses['future'] = esc_html__( 'Future', 'elementor' );
1962 }
1963
1964 $this->add_control(
1965 'post_status',
1966 [
1967 'label' => esc_html__( 'Status', 'elementor' ),
1968 'type' => Controls_Manager::SELECT,
1969 'default' => $this->get_main_post()->post_status,
1970 'options' => $statuses,
1971 ]
1972 );
1973 }
1974
1975 $this->end_controls_section();
1976 }
1977
1978 protected function get_post_statuses() {
1979 return get_post_statuses();
1980 }
1981
1982 protected function get_have_a_look_url() {
1983 return $this->get_permalink();
1984 }
1985
1986 public function handle_revisions_changed( $post_has_changed, $last_revision, $post ) {
1987 // In case default, didn't determine the changes.
1988 if ( ! $post_has_changed ) {
1989 $last_revision_id = $last_revision->ID;
1990 $last_revision_document = Plugin::instance()->documents->get( $last_revision_id );
1991 $post_document = Plugin::instance()->documents->get( $post->ID );
1992
1993 $last_revision_settings = $last_revision_document->get_settings();
1994 $post_settings = $post_document->get_settings();
1995
1996 // TODO: Its better to add crc32 signature for each revision and then only compare one part of the checksum.
1997 $post_has_changed = $last_revision_settings !== $post_settings;
1998 }
1999
2000 return $post_has_changed;
2001 }
2002
2003 private function add_handle_revisions_changed_filter() {
2004 add_filter( 'wp_save_post_revision_post_has_changed', [ $this, 'handle_revisions_changed' ], 10, 3 );
2005 }
2006
2007 private function remove_handle_revisions_changed_filter() {
2008 remove_filter( 'wp_save_post_revision_post_has_changed', [ $this, 'handle_revisions_changed' ] );
2009 }
2010
2011 private function get_runtime_elements_iteration_actions() {
2012 $runtime_elements_iteration_actions = [];
2013
2014 $elements_iteration_actions = $this->get_elements_iteration_actions();
2015
2016 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2017 if ( $elements_iteration_action->is_action_needed() ) {
2018 $runtime_elements_iteration_actions[] = $elements_iteration_action;
2019 }
2020 }
2021
2022 return $runtime_elements_iteration_actions;
2023 }
2024
2025 private function iterate_elements( $elements, $elements_iteration_actions, $mode ) {
2026 $unique_page_elements = [];
2027
2028 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2029 $elements_iteration_action->set_mode( $mode );
2030 }
2031
2032 Plugin::$instance->db->iterate_data( $elements, function( array $element_data ) use ( &$unique_page_elements, $elements_iteration_actions ) {
2033 $element_type = 'widget' === $element_data['elType'] ? $element_data['widgetType'] : $element_data['elType'];
2034
2035 $element = Plugin::$instance->elements_manager->create_element_instance( $element_data );
2036
2037 if ( $element ) {
2038 if ( ! in_array( $element_type, $unique_page_elements, true ) ) {
2039 $unique_page_elements[] = $element_type;
2040
2041 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2042 $elements_iteration_action->unique_element_action( $element );
2043 }
2044 }
2045
2046 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2047 $elements_iteration_action->element_action( $element );
2048 }
2049 }
2050
2051 return $element_data;
2052 } );
2053
2054 foreach ( $elements_iteration_actions as $elements_iteration_action ) {
2055 $elements_iteration_action->after_elements_iteration();
2056 }
2057 }
2058
2059 private function get_elements_iteration_actions() {
2060 if ( ! $this->elements_iteration_actions ) {
2061 $this->elements_iteration_actions[] = new Assets_Iteration_Action( $this );
2062 }
2063
2064 return $this->elements_iteration_actions;
2065 }
2066 }
2067