elementor / modules / global-classes / module.php

module.php in Elementor Website Builder – more than just a page builder 4.2.1, at modules/global-classes/module.php

156 lines 5.4 KB

Raw Download Zip

1	<?php
2
3	namespace Elementor\Modules\GlobalClasses;
4
5	use Elementor\Core\Base\Module as BaseModule;
6	use Elementor\Core\Experiments\Manager as Experiments_Manager;
7	use Elementor\Modules\AtomicWidgets\Module as Atomic_Widgets_Module;
8	use Elementor\Modules\DesignSystemSync\Classes\Global_Classes_Sync_Map;
9	use Elementor\Modules\GlobalClasses\Database\Global_Classes_Database_Updater;
10	use Elementor\Modules\GlobalClasses\ImportExport\Import_Export;
11	use Elementor\Modules\GlobalClasses\ImportExportCustomization\Import_Export_Customization;
12	use Elementor\Modules\GlobalClasses\Utils\Template_Library_Global_Classes;
13	use Elementor\Modules\GlobalClasses\Usage\Global_Classes_Usage;
14	use Elementor\Plugin;
15
16	if ( ! defined( 'ABSPATH' ) ) {
17	exit; // Exit if accessed directly.
18	}
19
20	class Module extends BaseModule {
21	const NAME = 'e_classes';
22	const ENFORCE_CAPABILITIES_EXPERIMENT = 'global_classes_should_enforce_capabilities';
23
24	// TODO: Add global classes package
25	const PACKAGES = [
26	'editor-global-classes',
27	];
28
29	public function get_name() {
30	return 'global-classes';
31	}
32
33	public function __construct() {
34	parent::__construct();
35
36	$this->register_features();
37
38	$is_feature_active = Plugin::$instance->experiments->is_feature_active( self::NAME );
39	$is_atomic_widgets_active = Plugin::$instance->experiments->is_feature_active( Atomic_Widgets_Module::EXPERIMENT_NAME );
40
41	// TODO: When the `e_atomic_elements` feature is not hidden, add it as a dependency
42	if ( $is_feature_active && $is_atomic_widgets_active ) {
43	( new Global_Class_Post_Type() )->register();
44	( new Global_Classes_Post_IDs() )->register_hooks();
45
46	$relations = new Global_Classes_Relations();
47	$relations->register_hooks();
48
49	add_filter( 'elementor/editor/v2/packages', fn( $packages ) => $this->add_packages( $packages ) );
50
51	( new Global_Classes_Usage() )->register_hooks();
52	( new Global_Classes_REST_API() )->register_hooks();
53	( new Atomic_Global_Styles( $relations ) )->register_hooks();
54	( new Global_Classes_Cleanup() )->register_hooks();
55	( new Import_Export() )->register_hooks();
56	( new Import_Export_Customization() )->register_hooks();
57	( new Global_Classes_Database_Updater() )->register();
58
59	add_filter(
60	'elementor/template_library/export/build_snapshots',
61	[ Template_Library_Global_Classes::class, 'add_global_classes_snapshot' ],
62	10,
63	4
64	);
65
66	add_filter(
67	'elementor/template_library/get_data/extract_snapshots',
68	[ Template_Library_Global_Classes::class, 'extract_global_classes_from_data' ],
69	10,
70	3
71	);
72
73	add_filter(
74	'elementor/template_library/import/process_content',
75	[ Template_Library_Global_Classes::class, 'process_global_classes_import' ],
76	20,
77	3
78	);
79
80	add_filter(
81	'elementor/kit/meta_to_preserve_on_kit_import',
82	[ $this, 'add_meta_to_preserve_on_kit_import' ]
83	);
84
85	add_action( 'elementor/kit/after_new_kit_created', [ $this, 'create_global_classes_posts_for_new_kit' ], 10, 1 );
86	}
87	}
88
89	public function add_meta_to_preserve_on_kit_import( array $meta_keys ): array {
90	return array_merge( $meta_keys, [
91	Global_Classes_Order::META_KEY,
92	Global_Classes_Labels::META_KEY_FRONTEND,
93	Global_Classes_Labels::META_KEY_PREVIEW,
94	Global_Classes_Relations::META_KEY_FRONTEND,
95	Global_Classes_Relations::META_KEY_PREVIEW,
96	Global_Classes_Relations::META_KEY_USAGE_INDEXED_FRONTEND,
97	Global_Classes_Relations::META_KEY_USAGE_INDEXED_PREVIEW,
98	Global_Classes_Relations::META_KEY_CLASS_RELATED_POSTS_FRONTEND,
99	Global_Classes_Relations::META_KEY_CLASS_RELATED_POSTS_PREVIEW,
100	Global_Classes_Sync_Map::META_KEY,
101	] );
102	}
103
104	/**
105	* Duplicates global classes posts from the previous kit to the new kit, after a new kit is created.
106	* So each kit has its own, separate, global classes posts, and editing one kit's classes will not affect the other kits.
107	*
108	* @param array $params The parameters passed to the action - 'new_kit_id' and 'previous_kit_id'.
109	* @return void
110	*/
111	public function create_global_classes_posts_for_new_kit( array $params ): void {
112	[ 'new_kit_id' => $new_kit_id, 'previous_kit_id' => $previous_kit_id ] = $params;
113
114	$previous_kit = Plugin::$instance->kits_manager->get_kit( $previous_kit_id );
115	$new_kit = Plugin::$instance->kits_manager->get_kit( $new_kit_id );
116
117	if ( ! $previous_kit \|\| ! $new_kit ) {
118	return;
119	}
120
121	$all_classes = Global_Classes_Repository::make( $previous_kit )->get_order();
122
123	foreach ( $all_classes as $class_id ) {
124	Global_Class_Post::clone_to_other_kit( $class_id, $previous_kit, $new_kit );
125	}
126	}
127
128	private function register_features() {
129	Plugin::$instance->experiments->add_feature([
130	'name' => self::NAME,
131	'title' => esc_html__( 'Global Classes', 'elementor' ),
132	'description' => esc_html__( 'Enable global CSS classes.', 'elementor' ),
133	'hidden' => true,
134	'default' => Experiments_Manager::STATE_INACTIVE,
135	'release_status' => Experiments_Manager::RELEASE_STATUS_ALPHA,
136	'new_site' => [
137	'default_active' => true,
138	'minimum_installation_version' => '4.0.0',
139	],
140	]);
141
142	Plugin::$instance->experiments->add_feature([
143	'name' => self::ENFORCE_CAPABILITIES_EXPERIMENT,
144	'title' => esc_html__( 'Enforce global classes capabilities', 'elementor' ),
145	'description' => esc_html__( 'Enforce global classes capabilities.', 'elementor' ),
146	'hidden' => true,
147	'default' => Experiments_Manager::STATE_ACTIVE,
148	'release_status' => Experiments_Manager::RELEASE_STATUS_DEV,
149	]);
150	}
151
152	private function add_packages( $packages ) {
153	return array_merge( $packages, self::PACKAGES );
154	}
155	}
156