PluginProbe
Gutenberg / 8.7.1
Gutenberg v8.7.1
23.9.1 23.9.0 23.8.0 23.7.2 23.7.1 23.7.0 23.6.1 23.6.2 23.6.0 23.5.3 23.5.2 23.5.1 23.5.0 23.4.0 23.3.2 23.3.1 23.3.0 23.2.0 23.2.1 23.2.2 23.1.1 23.1.0 23.0.1 12.6.0 7.4.0 All 402 releases
gutenberg / lib / global-styles.php

global-styles.php in Gutenberg 8.7.1, at lib/global-styles.php

664 lines 20.4 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2 /**
3 * Bootstraps Global Styles.
4 *
5 * @package gutenberg
6 */
7
8 /**
9 * Whether the current theme has a theme.json file.
10 *
11 * @return boolean
12 */
13 function gutenberg_experimental_global_styles_has_theme_json_support() {
14 return is_readable( locate_template( 'experimental-theme.json' ) );
15 }
16
17 /**
18 * Given a tree, it creates a flattened one
19 * by merging the keys and binding the leaf values
20 * to the new keys.
21 *
22 * This is thought to be useful to generate
23 * CSS Custom Properties from a tree,
24 * although there's nothing in the implementation
25 * of this function that requires that format.
26 *
27 * For example, assuming the given prefix is '--wp'
28 * and the token is '--', for this input tree:
29 *
30 * {
31 * 'property': 'value',
32 * 'nested-property': {
33 * 'sub-property': 'value'
34 * }
35 * }
36 *
37 * it'll return this output:
38 *
39 * {
40 * '--wp--property': 'value',
41 * '--wp--nested-property--sub-property': 'value'
42 * }
43 *
44 * @param array $tree Input tree to process.
45 * @param string $prefix Prefix to prepend to each variable. '' by default.
46 * @param string $token Token to use between levels. '--' by default.
47 *
48 * @return array The flattened tree.
49 */
50 function gutenberg_experimental_global_styles_get_css_vars( $tree, $prefix = '', $token = '--' ) {
51 $result = array();
52 foreach ( $tree as $property => $value ) {
53 $new_key = $prefix . str_replace( '/', '-', $property );
54
55 if ( is_array( $value ) ) {
56 $new_prefix = $new_key . $token;
57 $result = array_merge(
58 $result,
59 gutenberg_experimental_global_styles_get_css_vars( $value, $new_prefix, $token )
60 );
61 } else {
62 $result[ $new_key ] = $value;
63 }
64 }
65 return $result;
66 }
67
68 /**
69 * Processes a file that adheres to the theme.json
70 * schema and returns an array with its contents,
71 * or a void array if none found.
72 *
73 * @param string $file_path Path to file.
74 * @return array Contents that adhere to the theme.json schema.
75 */
76 function gutenberg_experimental_global_styles_get_from_file( $file_path ) {
77 $config = array();
78 if ( file_exists( $file_path ) ) {
79 $decoded_file = json_decode(
80 file_get_contents( $file_path ),
81 true
82 );
83
84 $json_decoding_error = json_last_error();
85 if ( JSON_ERROR_NONE !== $json_decoding_error ) {
86 error_log( 'Error when decoding file schema: ' . json_last_error_msg() );
87 return $config;
88 }
89
90 if ( is_array( $decoded_file ) ) {
91 $config = $decoded_file;
92 }
93 }
94 return $config;
95 }
96
97 /**
98 * Returns the user's origin config.
99 *
100 * @return array Config that adheres to the theme.json schema.
101 */
102 function gutenberg_experimental_global_styles_get_user() {
103 $config = array();
104 $user_cpt = gutenberg_experimental_global_styles_get_user_cpt( array( 'publish' ) );
105 if ( array_key_exists( 'post_content', $user_cpt ) ) {
106 $decoded_data = json_decode( $user_cpt['post_content'], true );
107
108 $json_decoding_error = json_last_error();
109 if ( JSON_ERROR_NONE !== $json_decoding_error ) {
110 error_log( 'Error when decoding user schema: ' . json_last_error_msg() );
111 return $config;
112 }
113
114 if ( is_array( $decoded_data ) ) {
115 $config = $decoded_data;
116 }
117 }
118
119 return $config;
120 }
121
122 /**
123 * Returns the CPT that contains the user's origin config
124 * for the current theme or a void array if none found.
125 *
126 * It can also create and return a new draft CPT.
127 *
128 * @param array $post_status_filter Filter CPT by post status.
129 * ['publish'] by default, so it only fetches published posts.
130 * @param bool $should_create_draft Whether a new draft should be created if no CPT was found.
131 * False by default.
132 * @return array Custom Post Type for the user's origin config.
133 */
134 function gutenberg_experimental_global_styles_get_user_cpt( $post_status_filter = array( 'publish' ), $should_create_draft = false ) {
135 $user_cpt = array();
136 $post_type_filter = 'wp_global_styles';
137 $post_name_filter = 'wp-global-styles-' . strtolower( wp_get_theme()->get( 'TextDomain' ) );
138 $recent_posts = wp_get_recent_posts(
139 array(
140 'numberposts' => 1,
141 'orderby' => 'date',
142 'order' => 'desc',
143 'post_type' => $post_type_filter,
144 'post_status' => $post_status_filter,
145 'name' => $post_name_filter,
146 )
147 );
148
149 if ( is_array( $recent_posts ) && ( count( $recent_posts ) === 1 ) ) {
150 $user_cpt = $recent_posts[0];
151 } elseif ( $should_create_draft ) {
152 $cpt_post_id = wp_insert_post(
153 array(
154 'post_content' => '{}',
155 'post_status' => 'draft',
156 'post_type' => $post_type_filter,
157 'post_name' => $post_name_filter,
158 ),
159 true
160 );
161 $user_cpt = get_post( $cpt_post_id, ARRAY_A );
162 }
163
164 return $user_cpt;
165 }
166
167 /**
168 * Returns the post ID of the CPT containing the user's origin config.
169 *
170 * @return integer
171 */
172 function gutenberg_experimental_global_styles_get_user_cpt_id() {
173 $user_cpt_id = null;
174 $user_cpt = gutenberg_experimental_global_styles_get_user_cpt( array( 'publish', 'draft' ), true );
175 if ( array_key_exists( 'ID', $user_cpt ) ) {
176 $user_cpt_id = $user_cpt['ID'];
177 }
178 return $user_cpt_id;
179 }
180
181 /**
182 * Return core's origin config.
183 *
184 * @return array Config that adheres to the theme.json schema.
185 */
186 function gutenberg_experimental_global_styles_get_core() {
187 $config = gutenberg_experimental_global_styles_get_from_file(
188 __DIR__ . '/experimental-default-theme.json'
189 );
190
191 return $config;
192 }
193
194 /**
195 * Returns the theme presets registered via add_theme_support, if any.
196 *
197 * @return array Config that adheres to the theme.json schema.
198 */
199 function gutenberg_experimental_global_styles_get_theme_presets() {
200 $theme_presets = array();
201
202 $theme_colors = gutenberg_experimental_get( get_theme_support( 'editor-color-palette' ), array( '0' ) );
203 foreach ( $theme_colors as $color ) {
204 $theme_presets['global']['presets']['color'][] = array(
205 'slug' => $color['slug'],
206 'value' => $color['color'],
207 );
208 }
209
210 $theme_gradients = gutenberg_experimental_get( get_theme_support( 'editor-gradient-presets' ), array( '0' ) );
211 foreach ( $theme_gradients as $gradient ) {
212 $theme_presets['global']['presets']['gradient'][] = array(
213 'slug' => $gradient['slug'],
214 'value' => $gradient['gradient'],
215 );
216 }
217
218 $theme_font_sizes = gutenberg_experimental_get( get_theme_support( 'editor-font-sizes' ), array( '0' ) );
219 foreach ( $theme_font_sizes as $font_size ) {
220 $theme_presets['global']['presets']['font-size'][] = array(
221 'slug' => $font_size['slug'],
222 'value' => $font_size['size'],
223 );
224 }
225
226 return $theme_presets;
227 }
228
229 /**
230 * Returns the theme's origin config.
231 *
232 * It also fetches the existing presets the theme declared via add_theme_support
233 * and uses them if the theme hasn't declared any via theme.json.
234 *
235 * @return array Config that adheres to the theme.json schema.
236 */
237 function gutenberg_experimental_global_styles_get_theme() {
238 $theme_presets = gutenberg_experimental_global_styles_get_theme_presets();
239 $theme_config = gutenberg_experimental_global_styles_get_from_file(
240 locate_template( 'experimental-theme.json' )
241 );
242
243 /*
244 * We want the presets declared in theme.json
245 * to take precedence over the ones declared via add_theme_support.
246 *
247 * Note that merging happens at the preset category level. Example:
248 *
249 * - if the theme declares a color palette via add_theme_support &
250 * a set of font sizes via theme.json, both will be included in the output.
251 *
252 * - if the theme declares a color palette both via add_theme_support &
253 * via theme.json, the later takes precedence.
254 *
255 */
256 $theme_config = gutenberg_experimental_global_styles_merge_trees(
257 $theme_presets,
258 $theme_config
259 );
260
261 return $theme_config;
262 }
263
264 /**
265 * Returns the style features a particular block supports.
266 *
267 * @param array $supports The block supports array.
268 *
269 * @return array Style features supported by the block.
270 */
271 function gutenberg_experimental_global_styles_get_supported_styles( $supports ) {
272 $style_features = array(
273 '--wp--style--color--link' => array( '__experimentalColor', 'linkColor' ),
274 'background-color' => array( '__experimentalColor' ),
275 'background' => array( '__experimentalColor', 'gradients' ),
276 'block-align' => array( 'align' ),
277 'color' => array( '__experimentalColor' ),
278 'font-size' => array( '__experimentalFontSize' ),
279 'line-height' => array( '__experimentalLineHeight' ),
280 );
281
282 $supported_features = array();
283 foreach ( $style_features as $style_feature => $path ) {
284 if ( gutenberg_experimental_get( $supports, $path ) ) {
285 $supported_features[] = $style_feature;
286 }
287 }
288
289 return $supported_features;
290 }
291
292 /**
293 * Retrieves the block data (selector/supports).
294 *
295 * @return array
296 */
297 function gutenberg_experimental_global_styles_get_block_data() {
298 $block_data = array(
299 'global' => array(
300 'selector' => ':root',
301 'supports' => array( 'background-color' ),
302 ),
303 );
304
305 $registry = WP_Block_Type_Registry::get_instance();
306 foreach ( $registry->get_all_registered() as $block_name => $block_type ) {
307 if ( empty( $block_type->supports ) || ! is_array( $block_type->supports ) ) {
308 continue;
309 }
310
311 $supports = gutenberg_experimental_global_styles_get_supported_styles( $block_type->supports );
312 if ( empty( $supports ) ) {
313 continue;
314 }
315
316 /*
317 * Assign the selector for the block.
318 *
319 * Some blocks can declare multiple selectors:
320 *
321 * - core/heading represents the H1-H6 HTML elements
322 * - core/list represents the UL and OL HTML elements
323 * - core/group is meant to represent DIV and other HTML elements
324 *
325 * Some other blocks don't provide a selector,
326 * so we generate a class for them based on their name:
327 *
328 * - 'core/group' => '.wp-block-group'
329 * - 'my-custom-library/block-name' => '.wp-block-my-custom-library-block-name'
330 *
331 * Note that, for core blocks, we don't add the `core/` prefix to its class name.
332 * This is for historical reasons, as they come with a class without that infix.
333 *
334 */
335 if (
336 isset( $block_type->supports['__experimentalSelector'] ) &&
337 is_string( $block_type->supports['__experimentalSelector'] )
338 ) {
339 $block_data[ $block_name ] = array(
340 'selector' => $block_type->supports['__experimentalSelector'],
341 'supports' => $supports,
342 );
343 } elseif (
344 isset( $block_type->supports['__experimentalSelector'] ) &&
345 is_array( $block_type->supports['__experimentalSelector'] )
346 ) {
347 foreach ( $block_type->supports['__experimentalSelector'] as $key => $selector ) {
348 $block_data[ $key ] = array(
349 'selector' => $selector,
350 'supports' => $supports,
351 );
352 }
353 } else {
354 $block_data[ $block_name ] = array(
355 'selector' => '.wp-block-' . str_replace( '/', '-', str_replace( 'core/', '', $block_name ) ),
356 'supports' => $supports,
357 );
358 }
359 }
360
361 return $block_data;
362 }
363
364 /**
365 * Given an array contain the styles shape returns the css for this styles.
366 * A similar function exists on the client at /packages/block-editor/src/hooks/style.js.
367 *
368 * @param array $styles Array containing the styles shape from global styles.
369 *
370 * @return array Containing a set of css rules.
371 */
372 function gutenberg_experimental_global_styles_flatten_styles_tree( $styles ) {
373 $mappings = array(
374 'line-height' => array( 'typography', 'lineHeight' ),
375 'font-size' => array( 'typography', 'fontSize' ),
376 'background' => array( 'color', 'gradient' ),
377 'background-color' => array( 'color', 'background' ),
378 'color' => array( 'color', 'text' ),
379 '--wp--style--color--link' => array( 'color', 'link' ),
380 );
381
382 $result = array();
383
384 foreach ( $mappings as $key => $path ) {
385 $value = gutenberg_experimental_get( $styles, $path, null );
386 if ( null !== $value ) {
387 $result[ $key ] = $value;
388 }
389 }
390 return $result;
391
392 }
393
394 /**
395 * Takes a tree adhering to the theme.json schema and generates
396 * the corresponding stylesheet.
397 *
398 * @param array $tree Input tree.
399 *
400 * @return string Stylesheet.
401 */
402 function gutenberg_experimental_global_styles_resolver( $tree ) {
403 $stylesheet = '';
404 $block_data = gutenberg_experimental_global_styles_get_block_data();
405 foreach ( array_keys( $tree ) as $block_name ) {
406 if (
407 ! array_key_exists( $block_name, $block_data ) ||
408 ! array_key_exists( 'selector', $block_data[ $block_name ] ) ||
409 ! array_key_exists( 'supports', $block_data[ $block_name ] )
410 ) {
411 // Skip blocks that haven't declared support,
412 // because we don't know to process them.
413 continue;
414 }
415
416 // Extract the relevant preset info before converting them to CSS Custom Properties.
417 foreach ( array_keys( $tree[ $block_name ]['presets'] ) as $preset_category ) {
418 $flattened_values = array();
419 foreach ( $tree[ $block_name ]['presets'][ $preset_category ] as $preset_value ) {
420 $flattened_values[ $preset_value['slug'] ] = $preset_value['value'];
421 }
422 $tree[ $block_name ]['presets'][ $preset_category ] = $flattened_values;
423 }
424
425 $token = '--';
426 $prefix = '--wp--preset' . $token;
427 $css_variables = gutenberg_experimental_global_styles_get_css_vars( $tree[ $block_name ]['presets'], $prefix, $token );
428
429 $stylesheet .= gutenberg_experimental_global_styles_resolver_styles(
430 $block_data[ $block_name ]['selector'],
431 $block_data[ $block_name ]['supports'],
432 array_merge(
433 gutenberg_experimental_global_styles_flatten_styles_tree( $tree[ $block_name ]['styles'] ),
434 $css_variables
435 )
436 );
437 }
438
439 if ( gutenberg_experimental_global_styles_has_theme_json_support() ) {
440 // To support all themes, we added in the block-library stylesheet
441 // a style rule such as .has-link-color a { color: var(--wp--style--color--link, #00e); }
442 // so that existing link colors themes used didn't break.
443 // We add this here to make it work for themes that opt-in to theme.json
444 // In the future, we may do this differently.
445 $stylesheet .= 'a { color: var(--wp--style--color--link, #00e); }';
446 }
447
448 return $stylesheet;
449 }
450
451 /**
452 * Generates CSS declarations for a block.
453 *
454 * @param string $block_selector CSS selector for the block.
455 * @param array $block_supports A list of properties supported by the block.
456 * @param array $block_styles The list of properties/values to be converted to CSS.
457 *
458 * @return string The corresponding CSS rule.
459 */
460 function gutenberg_experimental_global_styles_resolver_styles( $block_selector, $block_supports, $block_styles ) {
461 $css_rule = '';
462 $css_declarations = '';
463
464 foreach ( $block_styles as $property => $value ) {
465 // Only convert to CSS:
466 //
467 // 1) The style attributes the block has declared support for.
468 // 2) Any CSS custom property attached to the node.
469 if ( in_array( $property, $block_supports, true ) || strstr( $property, '--' ) ) {
470 $css_declarations .= "\t" . $property . ': ' . $value . ";\n";
471 }
472 }
473 if ( '' !== $css_declarations ) {
474 $css_rule .= $block_selector . " {\n";
475 $css_rule .= $css_declarations;
476 $css_rule .= "}\n";
477 }
478
479 return $css_rule;
480 }
481
482 /**
483 * Helper function that merges trees that adhere to the theme.json schema.
484 *
485 * @param array $core Core origin.
486 * @param array $theme Theme origin.
487 * @param array $user User origin. An empty array by default.
488 *
489 * @return array The merged result.
490 */
491 function gutenberg_experimental_global_styles_merge_trees( $core, $theme, $user = array() ) {
492 $core = gutenberg_experimental_global_styles_normalize_schema( $core );
493 $theme = gutenberg_experimental_global_styles_normalize_schema( $theme );
494 $user = gutenberg_experimental_global_styles_normalize_schema( $user );
495 $result = gutenberg_experimental_global_styles_normalize_schema( array() );
496
497 foreach ( array_keys( $core ) as $block_name ) {
498 foreach ( array( 'presets', 'features' ) as $subtree ) {
499 $result[ $block_name ][ $subtree ] = array_merge(
500 $core[ $block_name ][ $subtree ],
501 $theme[ $block_name ][ $subtree ],
502 $user[ $block_name ][ $subtree ]
503 );
504 }
505 foreach ( array_keys( $core[ $block_name ]['styles'] ) as $subtree ) {
506 $result[ $block_name ]['styles'][ $subtree ] = array_merge(
507 $core[ $block_name ]['styles'][ $subtree ],
508 $theme[ $block_name ]['styles'][ $subtree ],
509 $user[ $block_name ]['styles'][ $subtree ]
510 );
511 }
512 }
513
514 return $result;
515 }
516
517 /**
518 * Given a tree, it normalizes it to the expected schema.
519 *
520 * @param array $tree Source tree to normalize.
521 *
522 * @return array Normalized tree.
523 */
524 function gutenberg_experimental_global_styles_normalize_schema( $tree ) {
525 $block_schema = array(
526 'styles' => array(
527 'typography' => array(),
528 'color' => array(),
529 ),
530 'features' => array(),
531 'presets' => array(),
532 );
533
534 $normalized_tree = array();
535 $block_data = gutenberg_experimental_global_styles_get_block_data();
536 foreach ( array_keys( $block_data ) as $block_name ) {
537 $normalized_tree[ $block_name ] = $block_schema;
538 }
539
540 $tree = array_merge_recursive(
541 $normalized_tree,
542 $tree
543 );
544
545 return $tree;
546 }
547
548 /**
549 * Takes data from the different origins (core, theme, and user)
550 * and returns the merged result.
551 *
552 * @return array Merged trees.
553 */
554 function gutenberg_experimental_global_styles_get_merged_origins() {
555 $core = gutenberg_experimental_global_styles_get_core();
556 $theme = gutenberg_experimental_global_styles_get_theme();
557 $user = gutenberg_experimental_global_styles_get_user();
558 $merged = gutenberg_experimental_global_styles_merge_trees( $core, $theme, $user );
559
560 return $merged;
561 }
562
563 /**
564 * Fetches the preferences for each origin (core, theme, user)
565 * and enqueues the resulting stylesheet.
566 */
567 function gutenberg_experimental_global_styles_enqueue_assets() {
568 $merged = gutenberg_experimental_global_styles_get_merged_origins();
569 $stylesheet = gutenberg_experimental_global_styles_resolver( $merged );
570 if ( empty( $stylesheet ) ) {
571 return;
572 }
573
574 wp_register_style( 'global-styles', false, array(), true, true );
575 wp_add_inline_style( 'global-styles', $stylesheet );
576 wp_enqueue_style( 'global-styles' );
577 }
578
579 /**
580 * Returns the default config for editor features,
581 * or an empty array if none found.
582 *
583 * @param array $config Config to extract values from.
584 * @return array Default features config for the editor.
585 */
586 function gutenberg_experimental_global_styles_get_editor_features( $config ) {
587 if (
588 empty( $config['global']['features'] ) ||
589 ! is_array( $config['global']['features'] )
590 ) {
591 return array();
592 }
593
594 return $config['global']['features'];
595 }
596
597 /**
598 * Adds the necessary data for the Global Styles client UI to the block settings.
599 *
600 * @param array $settings Existing block editor settings.
601 * @return array New block editor settings
602 */
603 function gutenberg_experimental_global_styles_settings( $settings ) {
604
605 if ( gutenberg_experimental_global_styles_has_theme_json_support() ) {
606 $settings['__experimentalGlobalStylesUserEntityId'] = gutenberg_experimental_global_styles_get_user_cpt_id();
607
608 $global_styles = gutenberg_experimental_global_styles_merge_trees(
609 gutenberg_experimental_global_styles_get_core(),
610 gutenberg_experimental_global_styles_get_theme()
611 );
612
613 $settings['__experimentalGlobalStylesBase'] = $global_styles;
614 }
615
616 // Add the styles for the editor via the settings
617 // so they get processed as if they were added via add_editor_styles:
618 // they will get the editor wrapper class.
619 $merged = gutenberg_experimental_global_styles_get_merged_origins();
620 $stylesheet = gutenberg_experimental_global_styles_resolver( $merged );
621 $settings['styles'][] = array( 'css' => $stylesheet );
622
623 $settings['__experimentalFeatures'] = gutenberg_experimental_global_styles_get_editor_features( $merged );
624
625 return $settings;
626 }
627
628 /**
629 * Registers a Custom Post Type to store the user's origin config.
630 */
631 function gutenberg_experimental_global_styles_register_cpt() {
632 if ( ! gutenberg_experimental_global_styles_has_theme_json_support() ) {
633 return;
634 }
635
636 $args = array(
637 'label' => __( 'Global Styles', 'gutenberg' ),
638 'description' => 'CPT to store user design tokens',
639 'public' => false,
640 'show_ui' => false,
641 'show_in_rest' => true,
642 'rest_base' => '__experimental/global-styles',
643 'capabilities' => array(
644 'read' => 'edit_theme_options',
645 'create_posts' => 'edit_theme_options',
646 'edit_posts' => 'edit_theme_options',
647 'edit_published_posts' => 'edit_theme_options',
648 'delete_published_posts' => 'edit_theme_options',
649 'edit_others_posts' => 'edit_theme_options',
650 'delete_others_posts' => 'edit_theme_options',
651 ),
652 'map_meta_cap' => true,
653 'supports' => array(
654 'editor',
655 'revisions',
656 ),
657 );
658 register_post_type( 'wp_global_styles', $args );
659 }
660
661 add_action( 'init', 'gutenberg_experimental_global_styles_register_cpt' );
662 add_filter( 'block_editor_settings', 'gutenberg_experimental_global_styles_settings' );
663 add_action( 'wp_enqueue_scripts', 'gutenberg_experimental_global_styles_enqueue_assets' );
664