Repository navigation
Expand file tree
/
Copy pathcustom-css.php
More file actions
533 lines (466 loc) · 15.7 KB
/
Copy pathcustom-css.php
File metadata and controls
533 lines (466 loc) · 15.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
<?php
/**
* Custom CSS block support.
*
* @package gutenberg
*/
/**
* Checks whether a style node has a non-empty custom CSS string.
*
* @since 7.2.0
*
* @param mixed $style_node A style node, possibly containing a `css` key.
* @return bool Whether the node has a non-empty custom CSS string.
*/
function gutenberg_custom_css_has_value( $style_node ) {
return is_array( $style_node )
&& isset( $style_node['css'] )
&& is_string( $style_node['css'] )
&& '' !== trim( $style_node['css'] );
}
/**
* Collects the raw custom CSS strings defined for a block instance, across the
* default state, pseudo-states (e.g. `:hover`), and viewport states (e.g.
* `@mobile`), including combinations of the two.
*
* @since 7.2.0
*
* @param array $style The block's `style` attribute.
* @param string $block_name Block name.
* @param array $responsive_media_queries Media queries keyed by viewport state name (e.g. `@mobile`).
* @return array[] List of entries, each with `css`, `pseudo` (string|null),
* and `media_query` (string|null) keys.
*/
function gutenberg_get_custom_css_state_entries( $style, $block_name, $responsive_media_queries ) {
$entries = array();
if ( empty( $style ) || ! is_array( $style ) ) {
return $entries;
}
$supported_pseudo_states = WP_Theme_JSON_Gutenberg::VALID_BLOCK_PSEUDO_SELECTORS[ $block_name ] ?? array();
if ( gutenberg_custom_css_has_value( $style ) ) {
$entries[] = array(
'css' => $style['css'],
'pseudo' => null,
'media_query' => null,
);
}
foreach ( $supported_pseudo_states as $pseudo_state ) {
$pseudo_style = $style[ $pseudo_state ] ?? null;
if ( gutenberg_custom_css_has_value( $pseudo_style ) ) {
$entries[] = array(
'css' => $pseudo_style['css'],
'pseudo' => $pseudo_state,
'media_query' => null,
);
}
}
foreach ( $responsive_media_queries as $breakpoint => $media_query ) {
$breakpoint_style = $style[ $breakpoint ] ?? null;
if ( ! is_array( $breakpoint_style ) ) {
continue;
}
if ( gutenberg_custom_css_has_value( $breakpoint_style ) ) {
$entries[] = array(
'css' => $breakpoint_style['css'],
'pseudo' => null,
'media_query' => $media_query,
);
}
foreach ( $supported_pseudo_states as $pseudo_state ) {
$breakpoint_pseudo_style = $breakpoint_style[ $pseudo_state ] ?? null;
if ( gutenberg_custom_css_has_value( $breakpoint_pseudo_style ) ) {
$entries[] = array(
'css' => $breakpoint_pseudo_style['css'],
'pseudo' => $pseudo_state,
'media_query' => $media_query,
);
}
}
}
return $entries;
}
/**
* Validates and processes custom CSS state entries.
*
* @since 7.2.0
*
* @param array[] $state_entries Custom CSS state entries.
* @param string $selector Selector scoping the block instance.
* @return string Processed CSS.
*/
function gutenberg_process_custom_css_state_entries( $state_entries, $selector ) {
$processed_css = '';
foreach ( $state_entries as $entry ) {
// Validate CSS doesn't contain HTML markup (same validation as global styles REST API).
if ( preg_match( '#</?\w+#', $entry['css'] ) ) {
continue;
}
$entry_selector = null !== $entry['pseudo'] ? $selector . $entry['pseudo'] : $selector;
$entry_css = WP_Theme_JSON_Gutenberg::process_blocks_custom_css( $entry['css'], $entry_selector );
if ( empty( $entry_css ) ) {
continue;
}
$processed_css .= null !== $entry['media_query']
? $entry['media_query'] . '{' . $entry_css . '}'
: $entry_css;
}
return $processed_css;
}
/**
* Generates the custom CSS class name for a block and registers its stylesheet.
*
* @since 7.2.0
*
* @param array $parsed_block The parsed block.
* @return string|null The generated class name, or null if the block has no custom CSS to render.
*
* @phpstan-param array{
* blockName: string|null,
* attrs: array{
* className?: string,
* style?: array{
* css?: string,
* ...
* },
* ...
* },
* ...
* } $parsed_block
*/
function gutenberg_generate_custom_css_class_name( $parsed_block ) {
$style = $parsed_block['attrs']['style'] ?? null;
if ( empty( $style ) || ! is_array( $style ) ) {
return null;
}
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $parsed_block['blockName'] );
if ( ! block_has_support( $block_type, 'customCSS', true ) ) {
return null;
}
$viewport_settings = gutenberg_get_global_settings( array( 'viewport' ) );
$responsive_media_queries = WP_Theme_JSON_Gutenberg::get_viewport_media_queries( $viewport_settings );
$state_entries = gutenberg_get_custom_css_state_entries( $style, $parsed_block['blockName'], $responsive_media_queries );
if ( empty( $state_entries ) ) {
return null;
}
// Generate a unique class name for this block instance.
$class_name = wp_unique_id_from_values( $parsed_block, 'wp-custom-css-' );
$processed_css = gutenberg_process_custom_css_state_entries( $state_entries, '.' . $class_name );
if ( '' === $processed_css ) {
return null;
}
/**
* Reuse one handle so identical custom CSS is enqueued only once via
* {@see wp_unique_id_from_values()}. Explicitly declare the `wp-block-library`
* dependency so `global-styles` is guaranteed to print after it, preventing
* block default styles from unintentionally overriding global styles.
*/
$handle = 'wp-block-custom-css';
if ( ! wp_style_is( $handle, 'registered' ) ) {
wp_register_style( $handle, false, array( 'wp-block-library', 'global-styles' ) );
}
$after_styles = wp_styles()->get_data( $handle, 'after' );
if ( ! is_array( $after_styles ) ) {
$after_styles = array();
}
if ( ! in_array( $processed_css, $after_styles, true ) ) {
wp_add_inline_style( $handle, $processed_css );
}
return $class_name;
}
/**
* Render the custom CSS stylesheet and add class name to block as required.
*
* @since 7.0.0
*
* @param array $parsed_block The parsed block.
* @return array The same parsed block with custom CSS class name added if appropriate.
*
* @phpstan-param array{
* blockName: string|null,
* attrs: array{
* className?: string,
* style?: array{
* css?: string,
* ...
* },
* ...
* },
* ...
* } $parsed_block
*/
function gutenberg_render_custom_css_support_styles( $parsed_block ) {
$class_name = gutenberg_generate_custom_css_class_name( $parsed_block );
if ( null === $class_name ) {
return $parsed_block;
}
$existing_class_name = $parsed_block['attrs']['className'] ?? null;
$updated_class_name = is_string( $existing_class_name )
? "$existing_class_name $class_name"
: $class_name;
$parsed_block['attrs']['className'] = $updated_class_name;
return $parsed_block;
}
/**
* Enqueues the block custom CSS styles.
*
* @since 7.0.0
*/
function gutenberg_enqueue_block_custom_css() {
wp_enqueue_style( 'wp-block-custom-css' );
}
/**
* Applies the custom CSS class name to the block's rendered HTML.
*
* Uses the class name that {@see gutenberg_render_custom_css_support_styles()}
* stored in the block attributes. Blocks that a parent parsed and rendered
* itself never reach that filter, so the class name is generated here instead
* via {@see gutenberg_generate_custom_css_class_name()}.
*
* @since 7.0.0
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*
* @phpstan-param array{
* blockName: string|null,
* attrs: array{
* className?: string,
* style?: array{
* css?: string,
* ...
* },
* ...
* },
* ...
* } $block
*/
function gutenberg_render_custom_css_class_name( $block_content, $block ) {
$class_name_attr = $block['attrs']['className'] ?? null;
$class_name_prefix = 'wp-custom-css-';
$matched_class_name = null;
// Parse out the 'wp-custom-css-*' class name added by gutenberg_render_custom_css_support_styles().
if ( is_string( $class_name_attr ) && str_contains( $class_name_attr, $class_name_prefix ) ) {
$token_delimiter = " \t\f\r\n";
$class_token = strtok( $class_name_attr, $token_delimiter );
while ( false !== $class_token ) {
if ( str_starts_with( $class_token, $class_name_prefix ) ) {
$matched_class_name = $class_token;
break;
}
$class_token = strtok( $token_delimiter );
}
}
// Direct WP_Block::render() calls skip render_block_data for the block itself.
if ( null === $matched_class_name ) {
$matched_class_name = gutenberg_generate_custom_css_class_name( $block );
}
if ( null === $matched_class_name ) {
return $block_content;
}
$tags = new WP_HTML_Tag_Processor( $block_content );
if ( $tags->next_tag() ) {
$tags->add_class( 'has-custom-css' );
$tags->add_class( $matched_class_name );
}
return $tags->get_updated_html();
}
// Remove core filters and action to avoid rendering duplicate custom CSS styles.
if ( function_exists( 'wp_render_custom_css_class_name' ) ) {
remove_filter( 'render_block', 'wp_render_custom_css_class_name' );
}
if ( function_exists( 'wp_render_custom_css_support_styles' ) ) {
remove_filter( 'render_block_data', 'wp_render_custom_css_support_styles' );
}
if ( function_exists( 'wp_enqueue_block_custom_css' ) ) {
remove_action( 'wp_enqueue_scripts', 'wp_enqueue_block_custom_css' );
}
// Add Gutenberg filters and action.
add_filter( 'render_block', 'gutenberg_render_custom_css_class_name', 10, 2 );
add_filter( 'render_block_data', 'gutenberg_render_custom_css_support_styles', 10, 1 );
add_action( 'wp_enqueue_scripts', 'gutenberg_enqueue_block_custom_css', 1 );
/**
* Registers the style block attribute for block types that support it.
*
* @since 7.0.0
*
* @param WP_Block_Type $block_type Block Type.
*/
function gutenberg_register_custom_css_support( $block_type ) {
// Setup attributes and styles within that if needed.
if ( ! $block_type->attributes ) {
$block_type->attributes = array();
}
// Check for existing style attribute definition e.g. from block.json.
if ( array_key_exists( 'style', $block_type->attributes ) ) {
return;
}
$has_custom_css_support = block_has_support( $block_type, array( 'customCSS' ), true );
if ( $has_custom_css_support ) {
$block_type->attributes['style'] = array(
'type' => 'object',
);
}
}
/**
* Removes `css` keys from a block's `style` attribute, including any nested
* under pseudo-state (`:hover`) or viewport-state (`@mobile`) sub-objects.
*
* @since 7.2.0
*
* @param array $style The block's `style` attribute.
* @return array The style attribute with all `css` keys removed.
*/
function gutenberg_strip_custom_css_from_style_array( $style ) {
if ( ! is_array( $style ) ) {
return $style;
}
unset( $style['css'] );
foreach ( $style as $key => $value ) {
if ( is_string( $key ) && is_array( $value ) && ( str_starts_with( $key, ':' ) || str_starts_with( $key, '@' ) ) ) {
$nested_style = gutenberg_strip_custom_css_from_style_array( $value );
if ( empty( $nested_style ) ) {
unset( $style[ $key ] );
} else {
$style[ $key ] = $nested_style;
}
}
}
return $style;
}
/**
* Strips `style.css` attributes from all blocks in post content.
*
* Uses WP_Block_Parser::next_token() to scan block tokens and surgically
* replace only the attribute JSON that changed — no parse_blocks() +
* serialize_blocks() round-trip needed.
*
* @since 7.0.0
*
* @param string $content Post content to filter, expected to be escaped with slashes.
* @return string Filtered post content with block custom CSS removed.
*/
function gutenberg_strip_custom_css_from_blocks( $content ) {
if ( ! has_blocks( $content ) ) {
return $content;
}
$unslashed = stripslashes( $content );
$parser = new WP_Block_Parser();
$parser->document = $unslashed;
$parser->offset = 0;
$end = strlen( $unslashed );
$replacements = array();
while ( $parser->offset < $end ) {
$next_token = $parser->next_token();
list( $token_type, , $attrs, $start_offset, $token_length ) = $next_token;
if ( 'no-more-tokens' === $token_type ) {
break;
}
$parser->offset = $start_offset + $token_length;
if ( 'block-opener' !== $token_type && 'void-block' !== $token_type ) {
continue;
}
if ( ! isset( $attrs['style'] ) || ! is_array( $attrs['style'] ) ) {
continue;
}
$stripped_style = gutenberg_strip_custom_css_from_style_array( $attrs['style'] );
if ( $stripped_style === $attrs['style'] ) {
continue;
}
// Remove css and clean up empty style.
if ( empty( $stripped_style ) ) {
unset( $attrs['style'] );
} else {
$attrs['style'] = $stripped_style;
}
// Locate the JSON portion within the token.
$token_string = substr( $unslashed, $start_offset, $token_length );
$json_rel_start = strcspn( $token_string, '{' );
$json_rel_end = strrpos( $token_string, '}' );
$json_start = $start_offset + $json_rel_start;
$json_length = $json_rel_end - $json_rel_start + 1;
// Re-encode attributes. If attrs is now empty, remove JSON and trailing space.
if ( empty( $attrs ) ) {
// Remove the trailing space after JSON: `{"style":{"css":"x"}} ` → ``
$replacements[] = array( $json_start, $json_length + 1, '' );
} else {
$replacements[] = array( $json_start, $json_length, serialize_block_attributes( $attrs ) );
}
}
if ( empty( $replacements ) ) {
return $content;
}
// Build the result by splicing replacements into the original string.
$result = '';
$was_at = 0;
foreach ( $replacements as $replacement ) {
list( $offset, $length, $new_json ) = $replacement;
$result .= substr( $unslashed, $was_at, $offset - $was_at ) . $new_json;
$was_at = $offset + $length;
}
if ( $was_at < $end ) {
$result .= substr( $unslashed, $was_at );
}
return addslashes( $result );
}
/**
* Adds the filters to strip custom CSS from block content on save.
*
* @since 7.0.0
* @access private
*/
function gutenberg_custom_css_kses_init_filters() {
add_filter( 'content_save_pre', 'gutenberg_strip_custom_css_from_blocks', 8 );
add_filter( 'content_filtered_save_pre', 'gutenberg_strip_custom_css_from_blocks', 8 );
}
/**
* Removes the filters that strip custom CSS from block content on save.
*
* @since 7.0.0
* @access private
*/
function gutenberg_custom_css_remove_filters() {
remove_filter( 'content_save_pre', 'gutenberg_strip_custom_css_from_blocks', 8 );
remove_filter( 'content_filtered_save_pre', 'gutenberg_strip_custom_css_from_blocks', 8 );
}
/**
* Registers the custom CSS content filters if the user does not have the edit_css capability.
*
* @since 7.0.0
* @access private
*/
function gutenberg_custom_css_kses_init() {
gutenberg_custom_css_remove_filters();
if ( ! current_user_can( 'edit_css' ) ) {
gutenberg_custom_css_kses_init_filters();
}
}
/**
* Initializes custom CSS content filters when imported data should be filtered.
*
* This filter is the last being executed on force_filtered_html_on_import.
* If the input of the filter is true it means we are in an import situation and should
* enable the custom CSS filters, independently of the user capabilities.
*
* @since 7.0.0
* @access private
*
* @param mixed $arg Input argument of the filter.
* @return mixed Input argument of the filter.
*/
function gutenberg_custom_css_force_filtered_html_on_import_filter( $arg ) {
if ( $arg ) {
gutenberg_custom_css_kses_init_filters();
}
return $arg;
}
add_action( 'init', 'gutenberg_custom_css_kses_init', 20 );
add_action( 'set_current_user', 'gutenberg_custom_css_kses_init' );
add_filter( 'force_filtered_html_on_import', 'gutenberg_custom_css_force_filtered_html_on_import_filter', 999 );
// Register the block support.
WP_Block_Supports::get_instance()->register(
'custom-css',
array(
'register_attribute' => 'gutenberg_register_custom_css_support',
)
);