elementor / includes / template-library / sources / local.php

local.php in Elementor Website Builder – more than just a page builder 3.27.5, at includes/template-library/sources/local.php

1,779 lines 48.9 KB

Raw Download Zip

1	<?php
2	namespace Elementor\TemplateLibrary;
3
4	use Elementor\Core\Admin\Menu\Admin_Menu_Manager;
5	use Elementor\Core\Base\Document;
6	use Elementor\Core\Editor\Editor;
7	use Elementor\Core\Utils\Collection;
8	use Elementor\DB;
9	use Elementor\Core\Settings\Manager as SettingsManager;
10	use Elementor\Core\Settings\Page\Model;
11	use Elementor\Includes\TemplateLibrary\Sources\AdminMenuItems\Add_New_Template_Menu_Item;
12	use Elementor\Includes\TemplateLibrary\Sources\AdminMenuItems\Saved_Templates_Menu_Item;
13	use Elementor\Includes\TemplateLibrary\Sources\AdminMenuItems\Templates_Categories_Menu_Item;
14	use Elementor\Modules\Library\Documents\Library_Document;
15	use Elementor\Plugin;
16	use Elementor\Utils;
17	use Elementor\User;
18
19	if ( ! defined( 'ABSPATH' ) ) {
20	exit; // Exit if accessed directly.
21	}
22
23	/**
24	* Elementor template library local source.
25	*
26	* Elementor template library local source handler class is responsible for
27	* handling local Elementor templates saved by the user locally on his site.
28	*
29	* @since 1.0.0
30	*/
31	class Source_Local extends Source_Base {
32
33	/**
34	* Elementor template-library post-type slug.
35	*/
36	const CPT = 'elementor_library';
37
38	/**
39	* Elementor template-library taxonomy slug.
40	*/
41	const TAXONOMY_TYPE_SLUG = 'elementor_library_type';
42
43	/**
44	* Elementor template-library category slug.
45	*/
46	const TAXONOMY_CATEGORY_SLUG = 'elementor_library_category';
47
48	/**
49	* Elementor template-library meta key.
50	*
51	* @deprecated 2.3.0 Use `Elementor\Core\Base\Document::TYPE_META_KEY` const instead.
52	*/
53	const TYPE_META_KEY = '_elementor_template_type';
54
55	/**
56	* Elementor template-library temporary files folder.
57	*/
58	const TEMP_FILES_DIR = 'elementor/tmp';
59
60	/**
61	* Elementor template-library bulk export action name.
62	*/
63	const BULK_EXPORT_ACTION = 'elementor_export_multiple_templates';
64
65	const ADMIN_MENU_SLUG = 'edit.php?post_type=elementor_library';
66
67	const ADMIN_MENU_PRIORITY = 10;
68
69	const ADMIN_SCREEN_ID = 'edit-elementor_library';
70
71	/**
72	* Template types.
73	*
74	* Holds the list of supported template types that can be displayed.
75	*
76	* @access private
77	* @static
78	*
79	* @var array
80	*/
81	private static $template_types = [];
82
83	/**
84	* Post type object.
85	*
86	* Holds the post type object of the current post.
87	*
88	* @access private
89	*
90	* @var \WP_Post_Type
91	*/
92	private $post_type_object;
93
94	/**
95	* @since 2.3.0
96	* @access public
97	* @static
98	* @return array
99	*/
100	public static function get_template_types() {
101	return self::$template_types;
102	}
103
104	/**
105	* Get local template type.
106	*
107	* Retrieve the template type from the post meta.
108	*
109	* @since 1.0.0
110	* @access public
111	* @static
112	*
113	* @param int $template_id The template ID.
114	*
115	* @return mixed The value of meta data field.
116	*/
117	public static function get_template_type( $template_id ) {
118	return get_post_meta( $template_id, Document::TYPE_META_KEY, true );
119	}
120
121	/**
122	* Is base templates screen.
123	*
124	* Whether the current screen base is edit and the post type is template.
125	*
126	* @since 1.0.0
127	* @access public
128	* @static
129	*
130	* @return bool True on base templates screen, False otherwise.
131	*/
132	public static function is_base_templates_screen() {
133	global $current_screen;
134
135	if ( ! $current_screen ) {
136	return false;
137	}
138
139	return 'edit' === $current_screen->base && self::CPT === $current_screen->post_type;
140	}
141
142	/**
143	* Add template type.
144	*
145	* Register new template type to the list of supported local template types.
146	*
147	* @since 1.0.3
148	* @access public
149	* @static
150	*
151	* @param string $type Template type.
152	*/
153	public static function add_template_type( $type ) {
154	self::$template_types[ $type ] = $type;
155	}
156
157	/**
158	* Remove template type.
159	*
160	* Remove existing template type from the list of supported local template
161	* types.
162	*
163	* @since 1.8.0
164	* @access public
165	* @static
166	*
167	* @param string $type Template type.
168	*/
169	public static function remove_template_type( $type ) {
170	if ( isset( self::$template_types[ $type ] ) ) {
171	unset( self::$template_types[ $type ] );
172	}
173	}
174
175	public static function get_admin_url( $relative = false ) {
176	$base_url = self::ADMIN_MENU_SLUG;
177	if ( ! $relative ) {
178	$base_url = admin_url( $base_url );
179	}
180
181	return add_query_arg( 'tabs_group', 'library', $base_url );
182	}
183
184	/**
185	* Get local template ID.
186	*
187	* Retrieve the local template ID.
188	*
189	* @since 1.0.0
190	* @access public
191	*
192	* @return string The local template ID.
193	*/
194	public function get_id() {
195	return 'local';
196	}
197
198	/**
199	* Get local template title.
200	*
201	* Retrieve the local template title.
202	*
203	* @since 1.0.0
204	* @access public
205	*
206	* @return string The local template title.
207	*/
208	public function get_title() {
209	return esc_html__( 'Local', 'elementor' );
210	}
211
212	/**
213	* Register local template data.
214	*
215	* Used to register custom template data like a post type, a taxonomy or any
216	* other data.
217	*
218	* The local template class registers a new `elementor_library` post type
219	* and an `elementor_library_type` taxonomy. They are used to store data for
220	* local templates saved by the user on his site.
221	*
222	* @since 1.0.0
223	* @access public
224	*/
225	public function register_data() {
226	$labels = [
227	'name' => esc_html_x( 'My Templates', 'Template Library', 'elementor' ),
228	'singular_name' => esc_html_x( 'Template', 'Template Library', 'elementor' ),
229	'add_new' => esc_html__( 'Add New Template', 'elementor' ),
230	'add_new_item' => esc_html__( 'Add New Template', 'elementor' ),
231	'edit_item' => esc_html__( 'Edit Template', 'elementor' ),
232	'new_item' => esc_html__( 'New Template', 'elementor' ),
233	'all_items' => esc_html__( 'All Templates', 'elementor' ),
234	'view_item' => esc_html__( 'View Template', 'elementor' ),
235	'search_items' => esc_html__( 'Search Template', 'elementor' ),
236	'not_found' => esc_html__( 'No Templates found', 'elementor' ),
237	'not_found_in_trash' => esc_html__( 'No Templates found in Trash', 'elementor' ),
238	'parent_item_colon' => esc_html__( 'Parent Template:', 'elementor' ),
239	'menu_name' => esc_html_x( 'Templates', 'Template Library', 'elementor' ),
240	];
241
242	$args = [
243	'labels' => $labels,
244	'public' => true,
245	'rewrite' => false,
246	'menu_icon' => 'dashicons-admin-page',
247	'show_ui' => true,
248	'show_in_menu' => true,
249	'show_in_nav_menus' => false,
250	'exclude_from_search' => true,
251	'capability_type' => 'post',
252	'hierarchical' => false,
253	'supports' => [ 'title', 'thumbnail', 'author', 'elementor', 'custom-fields' ],
254	'show_in_rest' => true,
255	];
256
257	$this->avoid_rest_access_for_non_admins();
258
259	/**
260	* Register template library post type args.
261	*
262	* Filters the post type arguments when registering elementor template library post type.
263	*
264	* @since 1.0.0
265	*
266	* @param array $args Arguments for registering a post type.
267	*/
268	$args = apply_filters( 'elementor/template_library/sources/local/register_post_type_args', $args );
269
270	$this->post_type_object = register_post_type( self::CPT, $args );
271
272	$args = [
273	'hierarchical' => false,
274	'show_ui' => false,
275	'show_in_nav_menus' => false,
276	'show_admin_column' => true,
277	'query_var' => is_admin(),
278	'rewrite' => false,
279	'public' => false,
280	'label' => esc_html_x( 'Type', 'Template Library', 'elementor' ),
281	];
282
283	/**
284	* Register template library taxonomy args.
285	*
286	* Filters the taxonomy arguments when registering elementor template library taxonomy.
287	*
288	* @since 1.0.0
289	*
290	* @param array $args Arguments for registering a taxonomy.
291	*/
292	$args = apply_filters( 'elementor/template_library/sources/local/register_taxonomy_args', $args );
293
294	$cpts_to_associate = [ self::CPT ];
295
296	/**
297	* Custom post types to associate.
298	*
299	* Filters the list of custom post types when registering elementor template library taxonomy.
300	*
301	* @since 1.0.0
302	*
303	* @param array $cpts_to_associate Custom post types. Default is `elementor_library` post type.
304	*/
305	$cpts_to_associate = apply_filters( 'elementor/template_library/sources/local/register_taxonomy_cpts', $cpts_to_associate );
306
307	register_taxonomy( self::TAXONOMY_TYPE_SLUG, $cpts_to_associate, $args );
308
309	/**
310	* Categories
311	*/
312	$args = [
313	'hierarchical' => true,
314	'show_ui' => true,
315	'show_in_nav_menus' => false,
316	'show_admin_column' => true,
317	'query_var' => is_admin(),
318	'rewrite' => false,
319	'public' => false,
320	'labels' => [
321	'name' => esc_html_x( 'Categories', 'Template Library', 'elementor' ),
322	'singular_name' => esc_html_x( 'Category', 'Template Library', 'elementor' ),
323	'all_items' => esc_html_x( 'All Categories', 'Template Library', 'elementor' ),
324	],
325	];
326
327	/**
328	* Register template library category args.
329	*
330	* Filters the category arguments when registering elementor template library category.
331	*
332	* @since 2.4.0
333	*
334	* @param array $args Arguments for registering a category.
335	*/
336	$args = apply_filters( 'elementor/template_library/sources/local/register_category_args', $args );
337
338	register_taxonomy( self::TAXONOMY_CATEGORY_SLUG, self::CPT, $args );
339	}
340
341	/**
342	* Remove Add New item from admin menu.
343	*
344	* Fired by `admin_menu` action.
345	*
346	* @since 2.4.0
347	* @access public
348	*/
349	private function admin_menu_reorder( Admin_Menu_Manager $admin_menu ) {
350	global $submenu;
351
352	if ( ! isset( $submenu[ static::ADMIN_MENU_SLUG ] ) ) {
353	return;
354	}
355
356	remove_submenu_page( static::ADMIN_MENU_SLUG, static::ADMIN_MENU_SLUG );
357
358	$add_new_slug = 'post-new.php?post_type=' . static::CPT;
359	$category_slug = 'edit-tags.php?taxonomy=' . static::TAXONOMY_CATEGORY_SLUG . '&post_type=' . static::CPT;
360
361	$library_submenu = new Collection( $submenu[ static::ADMIN_MENU_SLUG ] );
362
363	$add_new_item = $library_submenu->find( function ( $item ) use ( $add_new_slug ) {
364	return $add_new_slug === $item[2];
365	} );
366
367	$categories_item = $library_submenu->find( function ( $item ) use ( $category_slug ) {
368	return $category_slug === $item[2];
369	} );
370
371	if ( $add_new_item ) {
372	remove_submenu_page( static::ADMIN_MENU_SLUG, $add_new_slug );
373
374	$admin_menu->register( admin_url( static::ADMIN_MENU_SLUG . '#add_new' ), new Add_New_Template_Menu_Item() );
375	}
376
377	if ( $categories_item ) {
378	remove_submenu_page( static::ADMIN_MENU_SLUG, $category_slug );
379
380	$admin_menu->register( $category_slug, new Templates_Categories_Menu_Item() );
381	}
382	}
383
384	/**
385	* Add a `current` CSS class to the `Saved Templates` submenu page when it's active.
386	* It should work by default, but since we interfere with WordPress' builtin CPT menus it doesn't work properly.
387	*
388	* @return void
389	*/
390	private function admin_menu_set_current() {
391	global $submenu;
392
393	if ( $this->is_current_screen() ) {
394	$library_submenu = &$submenu[ static::ADMIN_MENU_SLUG ];
395	$library_title = $this->get_library_title();
396
397	foreach ( $library_submenu as &$item ) {
398	if ( $library_title === $item[0] ) {
399	if ( ! isset( $item[4] ) ) {
400	$item[4] = '';
401	}
402	$item[4] .= ' current';
403	}
404	}
405	}
406	}
407
408	private function register_admin_menu( Admin_Menu_Manager $admin_menu ) {
409	$admin_menu->register( static::get_admin_url( true ), new Saved_Templates_Menu_Item() );
410	}
411
412	public function admin_title( $admin_title, $title ) {
413	$library_title = $this->get_library_title();
414
415	if ( $library_title ) {
416	$admin_title = str_replace( $title, $library_title, $admin_title );
417	}
418
419	return $admin_title;
420	}
421
422	public function replace_admin_heading() {
423	$library_title = $this->get_library_title();
424
425	if ( $library_title ) {
426	global $post_type_object;
427
428	$post_type_object->labels->name = $library_title;
429	}
430	}
431
432	/**
433	* Get local templates.
434	*
435	* Retrieve local templates saved by the user on his site.
436	*
437	* @since 1.0.0
438	* @access public
439	*
440	* @param array $args Optional. Filter templates based on a set of
441	* arguments. Default is an empty array.
442	*
443	* @return array Local templates.
444	*/
445	public function get_items( $args = [] ) {
446	$template_types = array_values( self::$template_types );
447
448	if ( ! empty( $args['type'] ) ) {
449	$template_types = $args['type'];
450	unset( $args['type'] );
451	}
452
453	$defaults = [
454	'post_type' => self::CPT,
455	'post_status' => 'publish',
456	'posts_per_page' => -1,
457	'orderby' => 'title',
458	'order' => 'ASC',
459	'meta_query' => [
460	[
461	'key' => Document::TYPE_META_KEY,
462	'value' => $template_types,
463	],
464	],
465	];
466
467	$query_args = wp_parse_args( $args, $defaults );
468
469	$templates_query = new \WP_Query( $query_args );
470
471	$templates = [];
472
473	if ( $templates_query->have_posts() ) {
474	foreach ( $templates_query->get_posts() as $post ) {
475	$templates[] = $this->get_item( $post->ID );
476	}
477	}
478
479	return $templates;
480	}
481
482	/**
483	* Save local template.
484	*
485	* Save new or update existing template on the database.
486	*
487	* @since 1.0.0
488	* @access public
489	*
490	* @param array $template_data Local template data.
491	*
492	* @return \WP_Error\|int The ID of the saved/updated template, `WP_Error` otherwise.
493	*/
494	public function save_item( $template_data ) {
495	if ( ! current_user_can( $this->post_type_object->cap->edit_posts ) ) {
496	return new \WP_Error( 'save_error', esc_html__( 'Access denied.', 'elementor' ) );
497	}
498
499	$defaults = [
500	'title' => esc_html__( '(no title)', 'elementor' ),
501	'page_settings' => [],
502	];
503
504	$template_data = wp_parse_args( $template_data, $defaults );
505	$template_data['status'] = current_user_can( 'publish_posts' ) ? 'publish' : 'pending';
506
507	// BC: Allow importing any template type when using CLI
508	// to support users that rely on this mechanism.
509	$should_check_template_type = ! $this->is_wp_cli();
510
511	if (
512	$should_check_template_type &&
513	! $this->is_valid_template_type( $template_data['type'] )
514	) {
515	return new \WP_Error( 'invalid_template_type', esc_html__( 'Invalid template type.', 'elementor' ) );
516	}
517
518	$document = Plugin::$instance->documents->create(
519	$template_data['type'],
520	[
521	'post_title' => $template_data['title'],
522	'post_status' => $template_data['status'],
523	]
524	);
525
526	if ( is_wp_error( $document ) ) {
527	/**
528	* @var \WP_Error $document
529	*/
530	return $document;
531	}
532
533	if ( ! empty( $template_data['content'] ) ) {
534	$template_data['content'] = $this->replace_elements_ids( $template_data['content'] );
535	}
536
537	$document->save( [
538	'elements' => $template_data['content'],
539	'settings' => $template_data['page_settings'],
540	] );
541
542	$template_id = $document->get_main_id();
543
544	/**
545	* After template library save.
546	*
547	* Fires after Elementor template library was saved.
548	*
549	* @since 1.0.1
550	*
551	* @param int $template_id The ID of the template.
552	* @param array $template_data The template data.
553	*/
554	do_action( 'elementor/template-library/after_save_template', $template_id, $template_data );
555
556	/**
557	* After template library update.
558	*
559	* Fires after Elementor template library was updated.
560	*
561	* @since 1.0.1
562	*
563	* @param int $template_id The ID of the template.
564	* @param array $template_data The template data.
565	*/
566	do_action( 'elementor/template-library/after_update_template', $template_id, $template_data );
567
568	return $template_id;
569	}
570
571	protected function is_valid_template_type( $type ) {
572	$document_class = Plugin::$instance->documents->get_document_type( $type, false );
573
574	if ( ! $document_class ) {
575	return false;
576	}
577
578	$cpt = $document_class::get_property( 'cpt' );
579
580	if ( ! $cpt \|\| ! is_array( $cpt ) \|\| 1 !== count( $cpt ) ) {
581	return false;
582	}
583
584	$is_valid_template_type = in_array( static::CPT, $cpt, true );
585
586	return apply_filters(
587	'elementor/template_library/sources/local/is_valid_template_type',
588	$is_valid_template_type,
589	$cpt,
590	);
591	}
592
593	// For testing purposes only, in order to be able to mock the `WP_CLI` constant.
594	protected function is_wp_cli() {
595	return Utils::is_wp_cli();
596	}
597
598	/**
599	* Update local template.
600	*
601	* Update template on the database.
602	*
603	* @since 1.0.0
604	* @access public
605	*
606	* @param array $new_data New template data.
607	*
608	* @return \WP_Error\|true True if template updated, `WP_Error` otherwise.
609	*/
610	public function update_item( $new_data ) {
611	if ( ! current_user_can( $this->post_type_object->cap->edit_post, $new_data['id'] ) ) {
612	return new \WP_Error( 'save_error', esc_html__( 'Access denied.', 'elementor' ) );
613	}
614
615	$document = Plugin::$instance->documents->get( $new_data['id'] );
616
617	if ( ! $document ) {
618	return new \WP_Error( 'save_error', esc_html__( 'Template not exist.', 'elementor' ) );
619	}
620
621	$document->save( [
622	'elements' => $new_data['content'],
623	] );
624
625	/**
626	* After template library update.
627	*
628	* Fires after Elementor template library was updated.
629	*
630	* @since 1.0.0
631	*
632	* @param int $new_data_id The ID of the new template.
633	* @param array $new_data The new template data.
634	*/
635	do_action( 'elementor/template-library/after_update_template', $new_data['id'], $new_data );
636
637	return true;
638	}
639
640	/**
641	* Get local template.
642	*
643	* Retrieve a single local template saved by the user on his site.
644	*
645	* @since 1.0.0
646	* @access public
647	*
648	* @param int $template_id The template ID.
649	*
650	* @return array Local template.
651	*/
652	public function get_item( $template_id ) {
653	$post = get_post( $template_id );
654
655	$user = get_user_by( 'id', $post->post_author );
656
657	$page = SettingsManager::get_settings_managers( 'page' )->get_model( $template_id );
658
659	$page_settings = $page->get_data( 'settings' );
660
661	$date = strtotime( $post->post_date );
662
663	$data = [
664	'template_id' => $post->ID,
665	'source' => $this->get_id(),
666	'type' => self::get_template_type( $post->ID ),
667	'title' => $post->post_title,
668	'thumbnail' => get_the_post_thumbnail_url( $post ),
669	'date' => $date,
670	'human_date' => date_i18n( get_option( 'date_format' ), $date ),
671	'human_modified_date' => date_i18n( get_option( 'date_format' ), strtotime( $post->post_modified ) ),
672	'author' => $user->display_name,
673	'status' => $post->post_status,
674	'hasPageSettings' => ! empty( $page_settings ),
675	'tags' => [],
676	'export_link' => $this->get_export_link( $template_id ),
677	'url' => get_permalink( $post->ID ),
678	];
679
680	/**
681	* Get template library template.
682	*
683	* Filters the template data when retrieving a single template from the
684	* template library.
685	*
686	* @since 1.0.0
687	*
688	* @param array $data Template data.
689	*/
690	$data = apply_filters( 'elementor/template-library/get_template', $data );
691
692	return $data;
693	}
694
695	/**
696	* Get template data.
697	*
698	* Retrieve the data of a single local template saved by the user on his site.
699	*
700	* @since 1.5.0
701	* @access public
702	*
703	* @param array $args Custom template arguments.
704	*
705	* @return array Local template data.
706	*/
707	public function get_data( array $args ) {
708	$template_id = $args['template_id'];
709
710	$document = Plugin::$instance->documents->get( $template_id );
711	$content = [];
712
713	if ( $document ) {
714	// TODO: Validate the data (in JS too!).
715	if ( ! empty( $args['display'] ) ) {
716	$content = $document->get_elements_raw_data( null, true );
717	} else {
718	$content = $document->get_elements_data();
719	}
720
721	if ( ! empty( $content ) ) {
722	$content = $this->replace_elements_ids( $content );
723	}
724	}
725
726	$data = [
727	'content' => $content,
728	];
729
730	if ( ! empty( $args['with_page_settings'] ) ) {
731	$page = SettingsManager::get_settings_managers( 'page' )->get_model( $args['template_id'] );
732
733	$data['page_settings'] = $page->get_data( 'settings' );
734	}
735
736	return $data;
737	}
738
739	/**
740	* Delete local template.
741	*
742	* Delete template from the database.
743	*
744	* @since 1.0.0
745	* @access public
746	*
747	* @param int $template_id The template ID.
748	*
749	* @return \WP_Post\|\WP_Error\|false\|null Post data on success, false or null
750	* or 'WP_Error' on failure.
751	*/
752	public function delete_template( $template_id ) {
753	if ( ! current_user_can( $this->post_type_object->cap->delete_post, $template_id ) ) {
754	return new \WP_Error( 'template_error', esc_html__( 'Access denied.', 'elementor' ) );
755	}
756
757	return wp_delete_post( $template_id, true );
758	}
759
760	/**
761	* Export local template.
762	*
763	* Export template to a file.
764	*
765	* @since 1.0.0
766	* @access public
767	*
768	* @param int $template_id The template ID.
769	*
770	* @return \WP_Error WordPress error if template export failed.
771	*/
772	public function export_template( $template_id ) {
773	$file_data = $this->prepare_template_export( $template_id );
774
775	if ( is_wp_error( $file_data ) ) {
776	return $file_data;
777	}
778
779	$this->send_file_headers( $file_data['name'], strlen( $file_data['content'] ) );
780
781	// Clear buffering just in case.
782	@ob_end_clean();
783
784	flush();
785
786	// Output file contents.
787	// PHPCS - Export widget json
788	echo $file_data['content']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
789
790	die;
791	}
792
793	/**
794	* Export multiple local templates.
795	*
796	* Export multiple template to a ZIP file.
797	*
798	* @since 1.6.0
799	* @access public
800	*
801	* @param array $template_ids An array of template IDs.
802	*
803	* @return \WP_Error WordPress error if export failed.
804	*/
805	public function export_multiple_templates( array $template_ids ) {
806	$files = [];
807
808	$wp_upload_dir = wp_upload_dir();
809
810	$temp_path = $wp_upload_dir['basedir'] . '/' . self::TEMP_FILES_DIR;
811
812	// Create temp path if it doesn't exist
813	wp_mkdir_p( $temp_path );
814
815	// Create all json files
816	foreach ( $template_ids as $template_id ) {
817	$file_data = $this->prepare_template_export( $template_id );
818
819	if ( is_wp_error( $file_data ) ) {
820	continue;
821	}
822
823	$complete_path = $temp_path . '/' . $file_data['name'];
824
825	$put_contents = file_put_contents( $complete_path, $file_data['content'] );
826
827	if ( ! $put_contents ) {
828	return new \WP_Error( '404', sprintf( 'Cannot create file "%s".', $file_data['name'] ) );
829	}
830
831	$files[] = [
832	'path' => $complete_path,
833	'name' => $file_data['name'],
834	];
835	}
836
837	if ( ! $files ) {
838	return new \WP_Error( 'empty_files', 'There is no files to export (probably all the requested templates are empty).' );
839	}
840
841	// Create temporary .zip file
842	$zip_archive_filename = 'elementor-templates-' . gmdate( 'Y-m-d' ) . '.zip';
843
844	$zip_archive = new \ZipArchive();
845
846	$zip_complete_path = $temp_path . '/' . $zip_archive_filename;
847
848	$zip_archive->open( $zip_complete_path, \ZipArchive::CREATE );
849
850	foreach ( $files as $file ) {
851	$zip_archive->addFile( $file['path'], $file['name'] );
852	}
853
854	$zip_archive->close();
855
856	foreach ( $files as $file ) {
857	unlink( $file['path'] );
858	}
859
860	$this->send_file_headers( $zip_archive_filename, filesize( $zip_complete_path ) );
861
862	@ob_end_flush();
863
864	@readfile( $zip_complete_path );
865
866	unlink( $zip_complete_path );
867
868	die;
869	}
870
871	/**
872	* Import local template.
873	*
874	* Import template from a file.
875	*
876	* @since 1.0.0
877	* @access public
878	*
879	* @param string $name - The file name
880	* @param string $path - The file path
881	* @return \WP_Error\|array An array of items on success, 'WP_Error' on failure.
882	*/
883	public function import_template( $name, $path ) {
884	if ( empty( $path ) ) {
885	return new \WP_Error( 'file_error', 'Please upload a file to import' );
886	}
887
888	// Set the Request's state as an Elementor upload request, in order to support unfiltered file uploads.
889	Plugin::$instance->uploads_manager->set_elementor_upload_state( true );
890
891	$items = [];
892
893	// If the import file is a Zip file with potentially multiple JSON files
894	if ( 'zip' === pathinfo( $name, PATHINFO_EXTENSION ) ) {
895	$extracted_files = Plugin::$instance->uploads_manager->extract_and_validate_zip( $path, [ 'json' ] );
896
897	if ( is_wp_error( $extracted_files ) ) {
898	// Delete the temporary extraction directory, since it's now not necessary.
899	Plugin::$instance->uploads_manager->remove_file_or_dir( $extracted_files['extraction_directory'] );
900
901	return $extracted_files;
902	}
903
904	foreach ( $extracted_files['files'] as $file_path ) {
905	$import_result = $this->import_single_template( $file_path );
906
907	if ( is_wp_error( $import_result ) ) {
908	// Delete the temporary extraction directory, since it's now not necessary.
909	Plugin::$instance->uploads_manager->remove_file_or_dir( $extracted_files['extraction_directory'] );
910
911	return $import_result;
912	}
913
914	$items[] = $import_result;
915	}
916
917	// Delete the temporary extraction directory, since it's now not necessary.
918	Plugin::$instance->uploads_manager->remove_file_or_dir( $extracted_files['extraction_directory'] );
919	} else {
920	// If the import file is a single JSON file
921	$import_result = $this->import_single_template( $path );
922
923	if ( is_wp_error( $import_result ) ) {
924	return $import_result;
925	}
926
927	$items[] = $import_result;
928	}
929
930	return $items;
931	}
932
933	/**
934	* Post row actions.
935	*
936	* Add an export link to the template library action links table list.
937	*
938	* Fired by `post_row_actions` filter.
939	*
940	* @since 1.0.0
941	* @access public
942	*
943	* @param array $actions An array of row action links.
944	* @param \WP_Post $post The post object.
945	*
946	* @return array An updated array of row action links.
947	*/
948	public function post_row_actions( $actions, \WP_Post $post ) {
949	if ( self::is_base_templates_screen() ) {
950	if ( $this->is_template_supports_export( $post->ID ) ) {
951	$actions['export-template'] = sprintf( '<a href="%1$s">%2$s</a>', $this->get_export_link( $post->ID ), esc_html__( 'Export Template', 'elementor' ) );
952	}
953	}
954
955	return $actions;
956	}
957
958	/**
959	* Admin import template form.
960	*
961	* The import form displayed in "My Library" screen in WordPress dashboard.
962	*
963	* The form allows the user to import template in json/zip format to the site.
964	*
965	* Fired by `admin_footer` action.
966	*
967	* @since 1.0.0
968	* @access public
969	*/
970	public function admin_import_template_form() {
971	if ( ! self::is_base_templates_screen() \|\| ! User::is_current_user_can_upload_json() ) {
972	return;
973	}
974
975	/** @var \Elementor\Core\Common\Modules\Ajax\Module $ajax */
976	$ajax = Plugin::$instance->common->get_component( 'ajax' );
977	?>
978	<div id="elementor-hidden-area">
979	<a id="elementor-import-template-trigger" class="page-title-action"><?php echo esc_html__( 'Import Templates', 'elementor' ); ?></a>
980	<div id="elementor-import-template-area">
981	<div id="elementor-import-template-title"><?php echo esc_html__( 'Choose an Elementor template JSON file or a .zip archive of Elementor templates, and add them to the list of templates available in your library.', 'elementor' ); ?></div>
982	<form id="elementor-import-template-form" method="post" action="<?php echo esc_url( admin_url( 'admin-ajax.php' ) ); ?>" enctype="multipart/form-data">
983	<input type="hidden" name="action" value="elementor_library_direct_actions">
984	<input type="hidden" name="library_action" value="direct_import_template">
985	<input type="hidden" name="_nonce" value="<?php Utils::print_unescaped_internal_string( $ajax->create_nonce() ); ?>">
986	<fieldset id="elementor-import-template-form-inputs">
987	<input type="file" name="file" accept=".json,application/json,.zip,application/octet-stream,application/zip,application/x-zip,application/x-zip-compressed" required>
988	<input id="e-import-template-action" type="submit" class="button" value="<?php echo esc_attr__( 'Import Now', 'elementor' ); ?>">
989	</fieldset>
990	</form>
991	</div>
992	</div>
993	<?php
994	}
995
996	/**
997	* Block template frontend
998	*
999	* Don't display the single view of the template library post type in the
1000	* frontend, for users that don't have the proper permissions.
1001	*
1002	* Fired by `template_redirect` action.
1003	*
1004	* @since 1.0.0
1005	* @access public
1006	*/
1007	public function block_template_frontend() {
1008	if ( is_singular( self::CPT ) && ! current_user_can( Editor::EDITING_CAPABILITY ) ) {
1009	wp_safe_redirect( site_url(), 301 );
1010	die;
1011	}
1012	}
1013
1014	/**
1015	* Is template library supports export.
1016	*
1017	* whether the template library supports export.
1018	*
1019	* Template saved by the user locally on his site, support export by default
1020	* but this can be changed using a filter.
1021	*
1022	* @since 1.0.0
1023	* @access public
1024	*
1025	* @param int $template_id The template ID.
1026	*
1027	* @return bool Whether the template library supports export.
1028	*/
1029	public function is_template_supports_export( $template_id ) {
1030	$export_support = true;
1031
1032	/**
1033	* Is template library supports export.
1034	*
1035	* Filters whether the template library supports export.
1036	*
1037	* @since 1.0.0
1038	*
1039	* @param bool $export_support Whether the template library supports export.
1040	* Default is true.
1041	* @param int $template_id Post ID.
1042	*/
1043	$export_support = apply_filters( 'elementor/template_library/is_template_supports_export', $export_support, $template_id );
1044
1045	return $export_support;
1046	}
1047
1048	/**
1049	* Remove Elementor post state.
1050	*
1051	* Remove the 'elementor' post state from the display states of the post.
1052	*
1053	* Used to remove the 'elementor' post state from the template library items.
1054	*
1055	* Fired by `display_post_states` filter.
1056	*
1057	* @since 1.8.0
1058	* @access public
1059	*
1060	* @param array $post_states An array of post display states.
1061	* @param \WP_Post $post The current post object.
1062	*
1063	* @return array Updated array of post display states.
1064	*/
1065	public function remove_elementor_post_state_from_library( $post_states, $post ) {
1066	if ( self::CPT === $post->post_type && isset( $post_states['elementor'] ) ) {
1067	unset( $post_states['elementor'] );
1068	}
1069	return $post_states;
1070	}
1071
1072	/**
1073	* Get template export link.
1074	*
1075	* Retrieve the link used to export a single template based on the template
1076	* ID.
1077	*
1078	* @since 2.0.0
1079	* @access private
1080	*
1081	* @param int $template_id The template ID.
1082	*
1083	* @return string Template export URL.
1084	*/
1085	private function get_export_link( $template_id ) {
1086	// TODO: BC since 2.3.0 - Use `$ajax->create_nonce()`
1087	/** @var \Elementor\Core\Common\Modules\Ajax\Module $ajax */
1088	// $ajax = Plugin::$instance->common->get_component( 'ajax' );
1089
1090	return add_query_arg(
1091	[
1092	'action' => 'elementor_library_direct_actions',
1093	'library_action' => 'export_template',
1094	'source' => $this->get_id(),
1095	'_nonce' => wp_create_nonce( 'elementor_ajax' ),
1096	'template_id' => $template_id,
1097	],
1098	admin_url( 'admin-ajax.php' )
1099	);
1100	}
1101
1102	/**
1103	* On template save.
1104	*
1105	* Run this method when template is being saved.
1106	*
1107	* Fired by `save_post` action.
1108	*
1109	* @since 1.0.1
1110	* @access public
1111	*
1112	* @param int $post_id Post ID.
1113	* @param \WP_Post $post The current post object.
1114	*/
1115	public function on_save_post( $post_id, \WP_Post $post ) {
1116	if ( self::CPT !== $post->post_type ) {
1117	return;
1118	}
1119
1120	if ( self::get_template_type( $post_id ) ) { // It's already with a type
1121	return;
1122	}
1123
1124	// Don't save type on import, the importer will do it.
1125	if ( did_action( 'import_start' ) ) {
1126	return;
1127	}
1128
1129	$this->save_item_type( $post_id, 'page' );
1130	}
1131
1132	/**
1133	* Save item type.
1134	*
1135	* When saving/updating templates, this method is used to update the post
1136	* meta data and the taxonomy.
1137	*
1138	* @since 1.0.1
1139	* @access private
1140	*
1141	* @param int $post_id Post ID.
1142	* @param string $type Item type.
1143	*/
1144	private function save_item_type( $post_id, $type ) {
1145	update_post_meta( $post_id, Document::TYPE_META_KEY, $type );
1146
1147	wp_set_object_terms( $post_id, $type, self::TAXONOMY_TYPE_SLUG );
1148	}
1149
1150	/**
1151	* Bulk export action.
1152	*
1153	* Adds an 'Export' action to the Bulk Actions drop-down in the template
1154	* library.
1155	*
1156	* Fired by `bulk_actions-edit-elementor_library` filter.
1157	*
1158	* @since 1.6.0
1159	* @access public
1160	*
1161	* @param array $actions An array of the available bulk actions.
1162	*
1163	* @return array An array of the available bulk actions.
1164	*/
1165	public function admin_add_bulk_export_action( $actions ) {
1166	$actions[ self::BULK_EXPORT_ACTION ] = esc_html__( 'Export', 'elementor' );
1167
1168	return $actions;
1169	}
1170
1171	/**
1172	* Add bulk export action.
1173	*
1174	* Handles the template library bulk export action.
1175	*
1176	* Fired by `handle_bulk_actions-edit-elementor_library` filter.
1177	*
1178	* @since 1.6.0
1179	* @access public
1180	*
1181	* @param string $redirect_to The redirect URL.
1182	* @param string $action The action being taken.
1183	* @param array $post_ids The items to take the action on.
1184	*/
1185	public function admin_export_multiple_templates( $redirect_to, $action, $post_ids ) {
1186	if ( self::BULK_EXPORT_ACTION === $action ) {
1187	$result = $this->export_multiple_templates( $post_ids );
1188
1189	// If you reach this line, the export failed
1190	// PHPCS - Not user input.
1191	wp_die( $result->get_error_message() ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1192	}
1193	}
1194
1195	/**
1196	* Print admin tabs.
1197	*
1198	* Used to output the template library tabs with their labels.
1199	*
1200	* Fired by `views_edit-elementor_library` filter.
1201	*
1202	* @since 2.0.0
1203	* @access public
1204	*
1205	* @param array $views An array of available list table views.
1206	*
1207	* @return array An updated array of available list table views.
1208	*/
1209	public function admin_print_tabs( $views ) {
1210	//phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce is not required to retrieve the value.
1211	$current_type = Utils::get_super_global_value( $_REQUEST, self::TAXONOMY_TYPE_SLUG ) ?? '';
1212	$active_class = $current_type ? '' : ' nav-tab-active';
1213	$current_tabs_group = $this->get_current_tab_group();
1214
1215	$url_args = [
1216	'post_type' => self::CPT,
1217	'tabs_group' => $current_tabs_group,
1218	];
1219
1220	$baseurl = add_query_arg( $url_args, admin_url( 'edit.php' ) );
1221
1222	$filter = [
1223	'admin_tab_group' => $current_tabs_group,
1224	];
1225	$operator = 'and';
1226
1227	if ( empty( $current_tabs_group ) ) {
1228	// Don't include 'not-supported' or other templates that don't set their `admin_tab_group`.
1229	$operator = 'NOT';
1230	}
1231
1232	$doc_types = Plugin::$instance->documents->get_document_types( $filter, $operator );
1233
1234	if ( 1 >= count( $doc_types ) ) {
1235	return $views;
1236	}
1237
1238	?>
1239	<div id="elementor-template-library-tabs-wrapper" class="nav-tab-wrapper">
1240	<a class="nav-tab<?php echo esc_attr( $active_class ); ?>" href="<?php echo esc_url( $baseurl ); ?>">
1241	<?php
1242	$all_title = $this->get_library_title();
1243	if ( ! $all_title ) {
1244	$all_title = esc_html__( 'All', 'elementor' );
1245	}
1246	Utils::print_unescaped_internal_string( $all_title ); ?>
1247	</a>
1248	<?php
1249	foreach ( $doc_types as $type => $class_name ) :
1250	$active_class = '';
1251
1252	if ( $current_type === $type ) {
1253	$active_class = ' nav-tab-active';
1254	}
1255
1256	$type_url = esc_url( add_query_arg( self::TAXONOMY_TYPE_SLUG, $type, $baseurl ) );
1257	$type_label = $this->get_template_label_by_type( $type );
1258	Utils::print_unescaped_internal_string( "<a class='nav-tab{$active_class}' href='{$type_url}'>{$type_label}</a>" );
1259	endforeach;
1260	?>
1261	</div>
1262	<?php
1263	return $views;
1264	}
1265
1266	/**
1267	* Maybe render blank state.
1268	*
1269	* When the template library has no saved templates, display a blank admin page offering
1270	* to create the very first template.
1271	*
1272	* Fired by `manage_posts_extra_tablenav` action.
1273	*
1274	* @since 2.0.0
1275	* @access public
1276	*
1277	* @param string $which The location of the extra table nav markup: 'top' or 'bottom'.
1278	* @param array $args
1279	*/
1280	public function maybe_render_blank_state( $which, array $args = [] ) {
1281	global $post_type;
1282
1283	$args = wp_parse_args( $args, [
1284	'cpt' => self::CPT,
1285	'post_type' => get_query_var( 'elementor_library_type' ),
1286	] );
1287
1288	if ( $args['cpt'] !== $post_type \|\| 'bottom' !== $which ) {
1289	return;
1290	}
1291
1292	global $wp_list_table;
1293
1294	$total_items = $wp_list_table->get_pagination_arg( 'total_items' );
1295
1296	//phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce is not required to retrieve the value.
1297	if ( ! empty( $total_items ) \|\| ! empty( $_REQUEST['s'] ) ) {
1298	return;
1299	}
1300
1301	$current_type = $args['post_type'];
1302
1303	$document_types = Plugin::instance()->documents->get_document_types();
1304
1305	if ( empty( $document_types[ $current_type ] ) ) {
1306	return;
1307	}
1308
1309	// TODO: Better way to exclude widget type.
1310	if ( 'widget' === $current_type ) {
1311	return;
1312	}
1313
1314	// TODO: This code maybe unreachable see if above `if ( empty( $document_types[ $current_type ] ) )`.
1315	if ( empty( $current_type ) ) {
1316	$counts = (array) wp_count_posts( self::CPT );
1317	unset( $counts['auto-draft'] );
1318	$count = array_sum( $counts );
1319
1320	if ( 0 < $count ) {
1321	return;
1322	}
1323
1324	$current_type = 'template';
1325
1326	$args['additional_inline_style'] = '#elementor-template-library-tabs-wrapper {display: none;}';
1327	}
1328
1329	$this->render_blank_state( $current_type, $args );
1330	}
1331
1332	private function render_blank_state( $current_type, array $args = [] ) {
1333	$current_type_label = $this->get_template_label_by_type( $current_type );
1334	$inline_style = '#posts-filter .wp-list-table, #posts-filter .tablenav.top, .tablenav.bottom .actions, .wrap .subsubsub { display:none;}';
1335
1336	$args = wp_parse_args( $args, [
1337	'additional_inline_style' => '',
1338	'href' => '',
1339	'description' => esc_html__( 'Add templates and reuse them across your website. Easily export and import them to any other project, for an optimized workflow.', 'elementor' ),
1340	] );
1341	$inline_style .= $args['additional_inline_style'];
1342	?>
1343	<style type="text/css"><?php Utils::print_unescaped_internal_string( $inline_style ); ?></style>
1344	<div class="elementor-template_library-blank_state">
1345	<?php $this->print_blank_state_template( $current_type_label, $args['href'], $args['description'] ); ?>
1346	</div>
1347	<?php
1348	}
1349
1350	/**
1351	* Print Blank State Template
1352	*
1353	* When the an entity (CPT, Taxonomy...etc) has no saved items, print a blank admin page offering
1354	* to create the very first item.
1355	*
1356	* This method is public because it needs to be accessed from outside the Source_Local
1357	*
1358	* @since 3.1.0
1359	* @access public
1360	*
1361	* @param string $current_type_label The Entity title
1362	* @param string $href The URL for the 'Add New' button
1363	* @param string $description The sub title describing the Entity (Post Type, Taxonomy, etc.)
1364	*/
1365	public function print_blank_state_template( $current_type_label, $href, $description ) {
1366	?>
1367	<div class="elementor-blank_state">
1368	<i class="eicon-folder"></i>
1369	<h3>
1370	<?php
1371	/* translators: %s: Template type label. */
1372	printf( esc_html__( 'Create Your First %s', 'elementor' ), esc_html( $current_type_label ) );
1373	?>
1374	</h3>
1375	<p><?php echo wp_kses_post( $description ); ?></p>
1376	<a id="elementor-template-library-add-new" class="elementor-button e-primary" href="<?php echo esc_url( $href ); ?>">
1377	<?php
1378	/* translators: %s: Template type label. */
1379	printf( esc_html__( 'Add New %s', 'elementor' ), esc_html( $current_type_label ) );
1380	?>
1381	</a>
1382	</div>
1383	<?php
1384	}
1385
1386	/**
1387	* Add filter by category.
1388	*
1389	* In the templates library, add a filter by Elementor library category.
1390	*
1391	* @access public
1392	*
1393	* @param string $post_type The post type slug.
1394	*/
1395	public function add_filter_by_category( $post_type ) {
1396	if ( self::CPT !== $post_type ) {
1397	return;
1398	}
1399
1400	$all_items = get_taxonomy( self::TAXONOMY_CATEGORY_SLUG )->labels->all_items;
1401	$dropdown_options = [
1402	'show_option_all' => $all_items,
1403	'show_option_none' => $all_items,
1404	'hide_empty' => 0,
1405	'hierarchical' => 1,
1406	'show_count' => 0,
1407	'orderby' => 'name',
1408	'value_field' => 'slug',
1409	'taxonomy' => self::TAXONOMY_CATEGORY_SLUG,
1410	'name' => self::TAXONOMY_CATEGORY_SLUG,
1411	//phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce is not required to retrieve the value.
1412	'selected' => Utils::get_super_global_value( $_GET, self::TAXONOMY_CATEGORY_SLUG ) ?? '',
1413	];
1414
1415	printf(
1416	'<label class="screen-reader-text" for="%1$s">%2$s</label>',
1417	esc_attr( self::TAXONOMY_CATEGORY_SLUG ),
1418	esc_html_x( 'Filter by category', 'Template Library', 'elementor' )
1419	);
1420	wp_dropdown_categories( $dropdown_options );
1421	}
1422
1423	/**
1424	* Import single template.
1425	*
1426	* Import template from a file to the database.
1427	*
1428	* @since 1.6.0
1429	* @access private
1430	*
1431	* @param string $file_path File name.
1432	*
1433	* @return \WP_Error\|int\|array Local template array, or template ID, or
1434	* `WP_Error`.
1435	*/
1436	private function import_single_template( $file_path ) {
1437	$data = json_decode( Utils::file_get_contents( $file_path ), true );
1438
1439	if ( empty( $data ) ) {
1440	return new \WP_Error( 'file_error', 'Invalid File' );
1441	}
1442
1443	$content = $data['content'];
1444
1445	if ( ! is_array( $content ) ) {
1446	return new \WP_Error( 'file_error', 'Invalid Content In File' );
1447	}
1448
1449	$content = $this->process_export_import_content( $content, 'on_import' );
1450
1451	$page_settings = [];
1452
1453	if ( ! empty( $data['page_settings'] ) ) {
1454	$page = new Model( [
1455	'id' => 0,
1456	'settings' => $data['page_settings'],
1457	] );
1458
1459	$page_settings_data = $this->process_element_export_import_content( $page, 'on_import' );
1460
1461	if ( ! empty( $page_settings_data['settings'] ) ) {
1462	$page_settings = $page_settings_data['settings'];
1463	}
1464	}
1465
1466	$template_id = $this->save_item( [
1467	'content' => $content,
1468	'title' => $data['title'],
1469	'type' => $data['type'],
1470	'page_settings' => $page_settings,
1471	] );
1472
1473	if ( is_wp_error( $template_id ) ) {
1474	return $template_id;
1475	}
1476
1477	return $this->get_item( $template_id );
1478	}
1479
1480	/**
1481	* Prepare template to export.
1482	*
1483	* Retrieve the relevant template data and return them as an array.
1484	*
1485	* @since 1.6.0
1486	* @access private
1487	*
1488	* @param int $template_id The template ID.
1489	*
1490	* @return \WP_Error\|array Exported template data.
1491	*/
1492	private function prepare_template_export( $template_id ) {
1493	$document = Plugin::$instance->documents->get( $template_id );
1494
1495	$template_data = $document->get_export_data();
1496
1497	if ( empty( $template_data['content'] ) ) {
1498	return new \WP_Error( 'empty_template', 'The template is empty' );
1499	}
1500
1501	$export_data = [
1502	'content' => $template_data['content'],
1503	'page_settings' => $template_data['settings'],
1504	'version' => DB::DB_VERSION,
1505	'title' => $document->get_main_post()->post_title,
1506	'type' => self::get_template_type( $template_id ),
1507	];
1508
1509	return [
1510	'name' => 'elementor-' . $template_id . '-' . gmdate( 'Y-m-d' ) . '.json',
1511	'content' => wp_json_encode( $export_data ),
1512	];
1513	}
1514
1515	/**
1516	* Send file headers.
1517	*
1518	* Set the file header when export template data to a file.
1519	*
1520	* @since 1.6.0
1521	* @access private
1522	*
1523	* @param string $file_name File name.
1524	* @param int $file_size File size.
1525	*/
1526	private function send_file_headers( $file_name, $file_size ) {
1527	header( 'Content-Type: application/octet-stream' );
1528	header( 'Content-Disposition: attachment; filename=' . $file_name );
1529	header( 'Expires: 0' );
1530	header( 'Cache-Control: must-revalidate' );
1531	header( 'Pragma: public' );
1532	header( 'Content-Length: ' . $file_size );
1533	}
1534
1535	/**
1536	* Get template label by type.
1537	*
1538	* Retrieve the template label for any given template type.
1539	*
1540	* @since 2.0.0
1541	* @access private
1542	*
1543	* @param string $template_type Template type.
1544	*
1545	* @return string Template label.
1546	*/
1547	private function get_template_label_by_type( $template_type ) {
1548	$document_types = Plugin::instance()->documents->get_document_types();
1549
1550	if ( isset( $document_types[ $template_type ] ) ) {
1551	$template_label = call_user_func( [ $document_types[ $template_type ], 'get_title' ] );
1552	} else {
1553	$template_label = ucwords( str_replace( [ '_', '-' ], ' ', $template_type ) );
1554	}
1555
1556	/**
1557	* Template label by template type.
1558	*
1559	* Filters the template label by template type in the template library .
1560	*
1561	* @since 2.0.0
1562	*
1563	* @param string $template_label Template label.
1564	* @param string $template_type Template type.
1565	*/
1566	$template_label = apply_filters( 'elementor/template-library/get_template_label_by_type', $template_label, $template_type );
1567
1568	return $template_label;
1569	}
1570
1571	/**
1572	* Filter template types in admin query.
1573	*
1574	* Update the template types in the main admin query.
1575	*
1576	* Fired by `parse_query` action.
1577	*
1578	* @since 2.4.0
1579	* @access public
1580	*
1581	* @param \WP_Query $query The `WP_Query` instance.
1582	*/
1583	public function admin_query_filter_types( \WP_Query $query ) {
1584	if ( ! $this->is_current_screen() \|\| ! empty( $query->query_vars['meta_key'] ) ) {
1585	return;
1586	}
1587
1588	$current_tabs_group = $this->get_current_tab_group();
1589
1590	if ( isset( $query->query_vars[ self::TAXONOMY_CATEGORY_SLUG ] ) && '-1' === $query->query_vars[ self::TAXONOMY_CATEGORY_SLUG ] ) {
1591	unset( $query->query_vars[ self::TAXONOMY_CATEGORY_SLUG ] );
1592	}
1593
1594	if ( empty( $current_tabs_group ) ) {
1595	return;
1596	}
1597
1598	$doc_types = Plugin::$instance->documents->get_document_types( [
1599	'admin_tab_group' => $current_tabs_group,
1600	] );
1601
1602	$query->query_vars['meta_key'] = Document::TYPE_META_KEY;
1603	$query->query_vars['meta_value'] = array_keys( $doc_types );
1604	}
1605
1606	/**
1607	* Add template library actions.
1608	*
1609	* Register filters and actions for the template library.
1610	*
1611	* @since 2.0.0
1612	* @access private
1613	*/
1614	private function add_actions() {
1615	if ( is_admin() ) {
1616	add_action( 'elementor/admin/menu/register', function ( Admin_Menu_Manager $admin_menu ) {
1617	$this->register_admin_menu( $admin_menu );
1618	}, static::ADMIN_MENU_PRIORITY );
1619
1620	add_action( 'elementor/admin/menu/register', function ( Admin_Menu_Manager $admin_menu ) {
1621	$this->admin_menu_reorder( $admin_menu );
1622	}, 800 );
1623
1624	add_action( 'elementor/admin/menu/after_register', function () {
1625	$this->admin_menu_set_current();
1626	} );
1627
1628	add_filter( 'admin_title', [ $this, 'admin_title' ], 10, 2 );
1629	add_action( 'all_admin_notices', [ $this, 'replace_admin_heading' ] );
1630	add_filter( 'post_row_actions', [ $this, 'post_row_actions' ], 10, 2 );
1631	add_action( 'admin_footer', [ $this, 'admin_import_template_form' ] );
1632	add_action( 'save_post', [ $this, 'on_save_post' ], 10, 2 );
1633	add_filter( 'display_post_states', [ $this, 'remove_elementor_post_state_from_library' ], 11, 2 );
1634
1635	add_action( 'parse_query', [ $this, 'admin_query_filter_types' ] );
1636
1637	// Template filter by category.
1638	add_action( 'restrict_manage_posts', [ $this, 'add_filter_by_category' ] );
1639
1640	// Template type column.
1641	add_action( 'manage_' . self::CPT . '_posts_columns', [ $this, 'admin_columns_headers' ] );
1642	add_action( 'manage_' . self::CPT . '_posts_custom_column', [ $this, 'admin_columns_content' ], 10, 2 );
1643
1644	// Template library bulk actions.
1645	add_filter( 'bulk_actions-edit-elementor_library', [ $this, 'admin_add_bulk_export_action' ] );
1646	add_filter( 'handle_bulk_actions-edit-elementor_library', [ $this, 'admin_export_multiple_templates' ], 10, 3 );
1647
1648	// Print template library tabs.
1649	add_filter( 'views_edit-' . self::CPT, [ $this, 'admin_print_tabs' ] );
1650
1651	// Show blank state.
1652	add_action( 'manage_posts_extra_tablenav', [ $this, 'maybe_render_blank_state' ] );
1653	}
1654
1655	add_action( 'template_redirect', [ $this, 'block_template_frontend' ] );
1656
1657	// Remove elementor library templates from WP Sitemap
1658	add_filter(
1659	'wp_sitemaps_post_types',
1660	function( $post_types ) {
1661	return $this->remove_elementor_cpt_from_sitemap( $post_types );
1662	}
1663	);
1664	}
1665
1666	/**
1667	* @since 2.0.6
1668	* @access public
1669	*/
1670	public function admin_columns_content( $column_name, $post_id ) {
1671	if ( 'elementor_library_type' === $column_name ) {
1672	/** @var Document $document */
1673	$document = Plugin::$instance->documents->get( $post_id );
1674
1675	if ( $document && $document instanceof Library_Document ) {
1676	$document->print_admin_column_type();
1677	}
1678	}
1679	}
1680
1681	/**
1682	* @since 2.0.6
1683	* @access public
1684	*/
1685	public function admin_columns_headers( $posts_columns ) {
1686	// Replace original column that bind to the taxonomy - with another column.
1687	unset( $posts_columns['taxonomy-elementor_library_type'] );
1688
1689	$offset = 2;
1690
1691	$posts_columns = array_slice( $posts_columns, 0, $offset, true ) + [
1692	'elementor_library_type' => esc_html__( 'Type', 'elementor' ),
1693	] + array_slice( $posts_columns, $offset, null, true );
1694
1695	return $posts_columns;
1696	}
1697
1698	public function get_current_tab_group( $default = '' ) {
1699	//phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce verification is not required here.
1700	$current_tabs_group = Utils::get_super_global_value( $_REQUEST, 'tabs_group' ) ?? '';
1701	//phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce verification is not required here.
1702	$type_slug = Utils::get_super_global_value( $_REQUEST, self::TAXONOMY_TYPE_SLUG );
1703
1704	if ( $type_slug ) {
1705	$doc_type = Plugin::$instance->documents->get_document_type( $type_slug, '' );
1706	if ( $doc_type ) {
1707	$current_tabs_group = $doc_type::get_property( 'admin_tab_group' );
1708	}
1709	}
1710	return $current_tabs_group;
1711	}
1712
1713	private function get_library_title() {
1714	$title = '';
1715
1716	if ( $this->is_current_screen() ) {
1717	$current_tab_group = $this->get_current_tab_group();
1718
1719	if ( $current_tab_group ) {
1720	$titles = [
1721	'library' => esc_html__( 'Saved Templates', 'elementor' ),
1722	'theme' => esc_html__( 'Theme Builder', 'elementor' ),
1723	'popup' => esc_html__( 'Popups', 'elementor' ),
1724	];
1725
1726	if ( ! empty( $titles[ $current_tab_group ] ) ) {
1727	$title = $titles[ $current_tab_group ];
1728	}
1729	}
1730	}
1731
1732	return $title;
1733	}
1734
1735	private function is_current_screen() {
1736	global $pagenow, $typenow;
1737
1738	return 'edit.php' === $pagenow && self::CPT === $typenow;
1739	}
1740
1741	/**
1742	* @param array $post_types
1743	*
1744	* @return array
1745	*/
1746	private function remove_elementor_cpt_from_sitemap( array $post_types ) {
1747	unset( $post_types[ self::CPT ] );
1748
1749	return $post_types;
1750	}
1751
1752	private function avoid_rest_access_for_non_admins(): void {
1753	add_filter( 'rest_pre_dispatch', function ( $value, \WP_REST_Server $server, \WP_REST_Request $request ) {
1754	if ( strpos( $request->get_route(), self::CPT ) !== false ) {
1755	if ( ! current_user_can( 'manage_options' ) ) {
1756	return new \WP_Error( 'rest_forbidden', esc_html__( 'Sorry, you are not allowed to do that.', 'elementor' ), [ 'status' => rest_authorization_required_code() ] );
1757	}
1758	}
1759
1760	return $value;
1761	}, 10, 3 );
1762	}
1763
1764	/**
1765	* Template library local source constructor.
1766	*
1767	* Initializing the template library local source base by registering custom
1768	* template data and running custom actions.
1769	*
1770	* @since 1.0.0
1771	* @access public
1772	*/
1773	public function __construct() {
1774	parent::__construct();
1775
1776	$this->add_actions();
1777	}
1778	}
1779