class-initializer.php — WooCommerce 10.9.3

woocommerce / packages / email-editor / src / Integrations / Core / class-initializer.php

woocommerce / packages / email-editor / src / Integrations / Core Last commit date

Renderer 4 weeks ago class-initializer.php 3 months ago theme.json 5 months ago

class-initializer.php

274 lines

1	<?php
2	/**
3	* This file is part of the WooCommerce Email Editor package
4	*
5	* @package Automattic\WooCommerce\EmailEditor
6	*/
7
8	declare( strict_types = 1 );
9	namespace Automattic\WooCommerce\EmailEditor\Integrations\Core;
10
11	use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Layout\Flex_Layout_Renderer;
12	use Automattic\WooCommerce\EmailEditor\Engine\Renderer\ContentRenderer\Rendering_Context;
13	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Abstract_Block_Renderer;
14	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Audio;
15	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Button;
16	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Buttons;
17	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Column;
18	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Columns;
19	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Cover;
20	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Embed;
21	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Fallback;
22	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Gallery;
23	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Group;
24	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Image;
25	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\List_Block;
26	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\List_Item;
27	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Media_Text;
28	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Post_Content;
29	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Quote;
30	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Video;
31	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Social_Link;
32	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Social_Links;
33	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Table;
34	use Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks\Text;
35
36	/**
37	* Initializes the core blocks renderers.
38	*/
39	class Initializer {
40	/**
41	* List of supported WordPress core blocks in the email editor.
42	*/
43	const ALLOWED_BLOCK_TYPES = array(
44	'core/button',
45	'core/buttons',
46	'core/column',
47	'core/columns',
48	'core/group',
49	'core/heading',
50	'core/image',
51	'core/list',
52	'core/list-item',
53	'core/paragraph',
54	'core/quote',
55	'core/spacer',
56	'core/social-link',
57	'core/social-links',
58	'core/site-logo',
59	'core/site-title',
60	'core/table',
61	);
62
63	/**
64	* List of blocks that only need rendering capabilities (not available in email editor).
65	*
66	* To add a new render-only block:
67	* 1. Add the block name to this array
68	* 2. Optionally create a specific renderer in the Renderer/Blocks directory
69	* 3. Add the renderer case in the get_block_renderer method
70	*/
71	const RENDER_ONLY_BLOCK_TYPES = array(
72	'core/gallery',
73	'core/media-text',
74	'core/audio',
75	'core/embed',
76	'core/cover',
77	'core/video',
78	'core/post-title',
79	);
80
81	/**
82	* Cache renderers by block name.
83	*
84	* @var array<string, Abstract_Block_Renderer>
85	*/
86	private array $renderers = array();
87
88	/**
89	* Whether hooks have already been registered.
90	*
91	* @var bool
92	*/
93	private bool $initialized = false;
94
95	/**
96	* Initializes the core blocks renderers.
97	*/
98	public function initialize(): void {
99	if ( $this->initialized ) {
100	return;
101	}
102	$this->initialized = true;
103
104	add_filter( 'woocommerce_email_editor_theme_json', array( $this, 'adjust_theme_json' ), 10, 1 );
105	add_filter( 'safe_style_css', array( $this, 'allow_styles' ) );
106	add_action( 'woocommerce_email_editor_render_start', array( $this, 'reset_renderers' ) );
107	}
108
109	/**
110	* Clear cached renderer instances so stateful renderers reset between emails.
111	*/
112	public function reset_renderers(): void {
113	$this->renderers = array();
114	}
115
116	/**
117	* Adjusts the editor's theme to add blocks specific settings for core blocks.
118	*
119	* @param \WP_Theme_JSON $editor_theme_json Editor theme JSON.
120	*/
121	public function adjust_theme_json( \WP_Theme_JSON $editor_theme_json ): \WP_Theme_JSON {
122	$theme_json = (string) file_get_contents( __DIR__ . '/theme.json' );
123	$theme_json = json_decode( $theme_json, true );
124	/**
125	* Loaded theme json.
126	*
127	* @var array $theme_json
128	*/
129	$editor_theme_json->merge( new \WP_Theme_JSON( $theme_json, 'default' ) );
130	return $editor_theme_json;
131	}
132
133	/**
134	* Allow styles for the email editor.
135	*
136	* @param array\|null $allowed_styles Allowed styles.
137	*/
138	public function allow_styles( ?array $allowed_styles ): array {
139	// The styles can be null in some cases.
140	if ( ! is_array( $allowed_styles ) ) {
141	$allowed_styles = array();
142	}
143	$allowed_styles[] = 'display';
144	$allowed_styles[] = 'mso-padding-alt';
145	$allowed_styles[] = 'mso-font-width';
146	$allowed_styles[] = 'mso-text-raise';
147	return $allowed_styles;
148	}
149
150	/**
151	* Configure block settings for email editor support and rendering.
152	*
153	* This method handles three types of blocks:
154	* 1. Editor-available blocks: Set supports.email = true and render_email_callback
155	* 2. Render-only blocks: Only set render_email_callback (not available in editor)
156	* 3. Special blocks: Custom handling (e.g., core/post-content stateless renderer)
157	*
158	* @param array $settings Block settings.
159	* @return array Modified block settings.
160	*/
161	public function update_block_settings( array $settings ): array {
162	// Enable blocks in email editor and set rendering callback.
163	if ( in_array( $settings['name'], self::ALLOWED_BLOCK_TYPES, true ) ) {
164	$settings['supports']['email'] = true;
165	$settings['render_email_callback'] = array( $this, 'render_block' );
166	}
167
168	// Set rendering callback for render-only blocks (without enabling in editor).
169	if ( in_array( $settings['name'], self::RENDER_ONLY_BLOCK_TYPES, true ) ) {
170	$settings['render_email_callback'] = array( $this, 'render_block' );
171	}
172
173	return $settings;
174	}
175
176	/**
177	* Returns the block content rendered by the block renderer.
178	*
179	* @param string $block_content Block content.
180	* @param array $parsed_block Parsed block settings.
181	* @param Rendering_Context $rendering_context Rendering context.
182	* @return string
183	*/
184	public function render_block( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string {
185	if ( isset( $parsed_block['blockName'] ) ) {
186	$block_renderer = $this->get_block_renderer( $parsed_block['blockName'] );
187	return $block_renderer->render( $block_content, $parsed_block, $rendering_context );
188	}
189
190	return $block_content;
191	}
192
193	/**
194	* Return an instance of Abstract_Block_Renderer by the block name.
195	*
196	* @param string $block_name Block name.
197	* @return Abstract_Block_Renderer
198	*/
199	private function get_block_renderer( string $block_name ): Abstract_Block_Renderer {
200	if ( isset( $this->renderers[ $block_name ] ) ) {
201	return $this->renderers[ $block_name ];
202	}
203
204	switch ( $block_name ) {
205	case 'core/heading':
206	case 'core/paragraph':
207	case 'core/site-title':
208	case 'core/post-title':
209	$renderer = new Text();
210	break;
211	case 'core/column':
212	$renderer = new Column();
213	break;
214	case 'core/columns':
215	$renderer = new Columns();
216	break;
217	case 'core/list':
218	$renderer = new List_Block();
219	break;
220	case 'core/list-item':
221	$renderer = new List_Item();
222	break;
223	case 'core/image':
224	$renderer = new Image();
225	break;
226	case 'core/button':
227	$renderer = new Button();
228	break;
229	case 'core/buttons':
230	$renderer = new Buttons( new Flex_Layout_Renderer() );
231	break;
232	case 'core/group':
233	$renderer = new Group();
234	break;
235	case 'core/quote':
236	$renderer = new Quote();
237	break;
238	case 'core/social-link':
239	$renderer = new Social_Link();
240	break;
241	case 'core/social-links':
242	$renderer = new Social_Links();
243	break;
244	case 'core/table':
245	$renderer = new Table();
246	break;
247	case 'core/gallery':
248	$renderer = new Gallery();
249	break;
250	case 'core/media-text':
251	$renderer = new Media_Text();
252	break;
253	case 'core/audio':
254	$renderer = new Audio();
255	break;
256	case 'core/embed':
257	$renderer = new Embed();
258	break;
259	case 'core/cover':
260	$renderer = new Cover();
261	break;
262	case 'core/video':
263	$renderer = new Video();
264	break;
265	default:
266	$renderer = new Fallback();
267	break;
268	}
269
270	$this->renderers[ $block_name ] = $renderer;
271	return $renderer;
272	}
273	}
274