PluginProbe
Gutenberg / 8.5.1
Gutenberg v8.5.1
24.0.0 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 All 403 releases
gutenberg / lib / global-styles.php

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

633 lines 19.2 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 'color' => array( '__experimentalColor' ),
274 'background-color' => array( '__experimentalColor' ),
275 'background' => array( '__experimentalColor', 'gradients' ),
276 'line-height' => array( '__experimentalLineHeight' ),
277 'font-size' => array( '__experimentalFontSize' ),
278 );
279
280 $supported_features = array();
281 foreach ( $style_features as $style_feature => $path ) {
282 if ( gutenberg_experimental_get( $supports, $path ) ) {
283 $supported_features[] = $style_feature;
284 }
285 }
286
287 return $supported_features;
288 }
289
290 /**
291 * Retrieves the block data (selector/supports).
292 *
293 * @return array
294 */
295 function gutenberg_experimental_global_styles_get_block_data() {
296 $block_data = array(
297 'global' => array(
298 'selector' => ':root',
299 'supports' => array( 'background-color' ),
300 ),
301 );
302
303 $registry = WP_Block_Type_Registry::get_instance();
304 foreach ( $registry->get_all_registered() as $block_name => $block_type ) {
305 if ( empty( $block_type->supports ) || ! is_array( $block_type->supports ) ) {
306 continue;
307 }
308
309 $supports = gutenberg_experimental_global_styles_get_supported_styles( $block_type->supports );
310 if ( empty( $supports ) ) {
311 continue;
312 }
313
314 /*
315 * Assign the selector for the block.
316 *
317 * Some blocks can declare multiple selectors:
318 *
319 * - core/heading represents the H1-H6 HTML elements
320 * - core/list represents the UL and OL HTML elements
321 * - core/group is meant to represent DIV and other HTML elements
322 *
323 * Some other blocks don't provide a selector,
324 * so we generate a class for them based on their name:
325 *
326 * - 'core/group' => '.wp-block-group'
327 * - 'my-custom-library/block-name' => '.wp-block-my-custom-library-block-name'
328 *
329 * Note that, for core blocks, we don't add the `core/` prefix to its class name.
330 * This is for historical reasons, as they come with a class without that infix.
331 *
332 */
333 if (
334 isset( $block_type->supports['__experimentalSelector'] ) &&
335 is_string( $block_type->supports['__experimentalSelector'] )
336 ) {
337 $block_data[ $block_name ] = array(
338 'selector' => $block_type->supports['__experimentalSelector'],
339 'supports' => $supports,
340 );
341 } elseif (
342 isset( $block_type->supports['__experimentalSelector'] ) &&
343 is_array( $block_type->supports['__experimentalSelector'] )
344 ) {
345 foreach ( $block_type->supports['__experimentalSelector'] as $key => $selector ) {
346 $block_data[ $key ] = array(
347 'selector' => $selector,
348 'supports' => $supports,
349 );
350 }
351 } else {
352 $block_data[ $block_name ] = array(
353 'selector' => '.wp-block-' . str_replace( '/', '-', str_replace( 'core/', '', $block_name ) ),
354 'supports' => $supports,
355 );
356 }
357 }
358
359 return $block_data;
360 }
361
362 /**
363 * Given an array contain the styles shape returns the css for this styles.
364 * A similar function exists on the client at /packages/block-editor/src/hooks/style.js.
365 *
366 * @param array $styles Array containing the styles shape from global styles.
367 *
368 * @return array Containing a set of css rules.
369 */
370 function gutenberg_experimental_global_styles_flatten_styles_tree( $styles ) {
371 $mappings = array(
372 'line-height' => array( 'typography', 'lineHeight' ),
373 'font-size' => array( 'typography', 'fontSize' ),
374 'background' => array( 'color', 'gradient' ),
375 'background-color' => array( 'color', 'background' ),
376 'color' => array( 'color', 'text' ),
377 '--wp--style--color--link' => array( 'color', 'link' ),
378 );
379
380 $result = array();
381
382 foreach ( $mappings as $key => $path ) {
383 $value = gutenberg_experimental_get( $styles, $path, null );
384 if ( null !== $value ) {
385 $result[ $key ] = $value;
386 }
387 }
388 return $result;
389
390 }
391
392 /**
393 * Takes a tree adhering to the theme.json schema and generates
394 * the corresponding stylesheet.
395 *
396 * @param array $tree Input tree.
397 *
398 * @return string Stylesheet.
399 */
400 function gutenberg_experimental_global_styles_resolver( $tree ) {
401 $stylesheet = '';
402 $block_data = gutenberg_experimental_global_styles_get_block_data();
403 foreach ( array_keys( $tree ) as $block_name ) {
404 if (
405 ! array_key_exists( $block_name, $block_data ) ||
406 ! array_key_exists( 'selector', $block_data[ $block_name ] ) ||
407 ! array_key_exists( 'supports', $block_data[ $block_name ] )
408 ) {
409 // Skip blocks that haven't declared support,
410 // because we don't know to process them.
411 continue;
412 }
413
414 // Extract the relevant preset info before converting them to CSS Custom Properties.
415 foreach ( array_keys( $tree[ $block_name ]['presets'] ) as $preset_category ) {
416 $flattened_values = array();
417 foreach ( $tree[ $block_name ]['presets'][ $preset_category ] as $preset_value ) {
418 $flattened_values[ $preset_value['slug'] ] = $preset_value['value'];
419 }
420 $tree[ $block_name ]['presets'][ $preset_category ] = $flattened_values;
421 }
422
423 $token = '--';
424 $prefix = '--wp--preset' . $token;
425 $css_variables = gutenberg_experimental_global_styles_get_css_vars( $tree[ $block_name ]['presets'], $prefix, $token );
426
427 $stylesheet .= gutenberg_experimental_global_styles_resolver_styles(
428 $block_data[ $block_name ]['selector'],
429 $block_data[ $block_name ]['supports'],
430 array_merge(
431 gutenberg_experimental_global_styles_flatten_styles_tree( $tree[ $block_name ]['styles'] ),
432 $css_variables
433 )
434 );
435 }
436
437 if ( gutenberg_experimental_global_styles_has_theme_json_support() ) {
438 // To support all themes, we added in the block-library stylesheet
439 // a style rule such as .has-link-color a { color: var(--wp--style--color--link, #00e); }
440 // so that existing link colors themes used didn't break.
441 // We add this here to make it work for themes that opt-in to theme.json
442 // In the future, we may do this differently.
443 $stylesheet .= 'a { color: var(--wp--style--color--link, #00e); }';
444 }
445
446 return $stylesheet;
447 }
448
449 /**
450 * Generates CSS declarations for a block.
451 *
452 * @param string $block_selector CSS selector for the block.
453 * @param array $block_supports A list of properties supported by the block.
454 * @param array $block_styles The list of properties/values to be converted to CSS.
455 *
456 * @return string The corresponding CSS rule.
457 */
458 function gutenberg_experimental_global_styles_resolver_styles( $block_selector, $block_supports, $block_styles ) {
459 $css_rule = '';
460 $css_declarations = '';
461
462 foreach ( $block_styles as $property => $value ) {
463 // Only convert to CSS:
464 //
465 // 1) The style attributes the block has declared support for.
466 // 2) Any CSS custom property attached to the node.
467 if ( in_array( $property, $block_supports, true ) || strstr( $property, '--' ) ) {
468 $css_declarations .= "\t" . $property . ': ' . $value . ";\n";
469 }
470 }
471 if ( '' !== $css_declarations ) {
472 $css_rule .= $block_selector . " {\n";
473 $css_rule .= $css_declarations;
474 $css_rule .= "}\n";
475 }
476
477 return $css_rule;
478 }
479
480 /**
481 * Helper function that merges trees that adhere to the theme.json schema.
482 *
483 * @param array $core Core origin.
484 * @param array $theme Theme origin.
485 * @param array $user User origin. An empty array by default.
486 *
487 * @return array The merged result.
488 */
489 function gutenberg_experimental_global_styles_merge_trees( $core, $theme, $user = array() ) {
490 $core = gutenberg_experimental_global_styles_normalize_schema( $core );
491 $theme = gutenberg_experimental_global_styles_normalize_schema( $theme );
492 $user = gutenberg_experimental_global_styles_normalize_schema( $user );
493 $result = gutenberg_experimental_global_styles_normalize_schema( array() );
494
495 foreach ( array_keys( $core ) as $block_name ) {
496 foreach ( array( 'presets', 'styles', 'features' ) as $subtree ) {
497 $result[ $block_name ][ $subtree ] = array_merge(
498 $core[ $block_name ][ $subtree ],
499 $theme[ $block_name ][ $subtree ],
500 $user[ $block_name ][ $subtree ]
501 );
502 }
503 }
504
505 return $result;
506 }
507
508 /**
509 * Given a tree, it normalizes it to the expected schema.
510 *
511 * @param array $tree Source tree to normalize.
512 *
513 * @return array Normalized tree.
514 */
515 function gutenberg_experimental_global_styles_normalize_schema( $tree ) {
516 $block_schema = array(
517 'styles' => array(),
518 'features' => array(),
519 'presets' => array(),
520 );
521
522 $normalized_tree = array();
523 $block_data = gutenberg_experimental_global_styles_get_block_data();
524 foreach ( array_keys( $block_data ) as $block_name ) {
525 $normalized_tree[ $block_name ] = $block_schema;
526 }
527
528 $tree = array_merge_recursive(
529 $normalized_tree,
530 $tree
531 );
532
533 return $tree;
534 }
535
536 /**
537 * Returns the stylesheet resulting of merging
538 * core's, theme's, and user's origins.
539 *
540 * @return string
541 */
542 function gutenberg_experimental_global_styles_get_stylesheet() {
543 $gs_merged = array();
544 $gs_core = gutenberg_experimental_global_styles_get_core();
545 $gs_theme = gutenberg_experimental_global_styles_get_theme();
546 $gs_user = gutenberg_experimental_global_styles_get_user();
547
548 $gs_merged = gutenberg_experimental_global_styles_merge_trees( $gs_core, $gs_theme, $gs_user );
549
550 $stylesheet = gutenberg_experimental_global_styles_resolver( $gs_merged );
551 if ( empty( $stylesheet ) ) {
552 return;
553 }
554 return $stylesheet;
555 }
556
557 /**
558 * Fetches the preferences for each origin (core, theme, user)
559 * and enqueues the resulting stylesheet.
560 */
561 function gutenberg_experimental_global_styles_enqueue_assets() {
562
563 $stylesheet = gutenberg_experimental_global_styles_get_stylesheet();
564
565 wp_register_style( 'global-styles', false, array(), true, true );
566 wp_add_inline_style( 'global-styles', $stylesheet );
567 wp_enqueue_style( 'global-styles' );
568 }
569
570 /**
571 * Adds the necessary data for the Global Styles client UI to the block settings.
572 *
573 * @param array $settings Existing block editor settings.
574 * @return array New block editor settings
575 */
576 function gutenberg_experimental_global_styles_settings( $settings ) {
577
578 if ( gutenberg_experimental_global_styles_has_theme_json_support() ) {
579 $settings['__experimentalGlobalStylesUserEntityId'] = gutenberg_experimental_global_styles_get_user_cpt_id();
580
581 $global_styles = gutenberg_experimental_global_styles_merge_trees(
582 gutenberg_experimental_global_styles_get_core(),
583 gutenberg_experimental_global_styles_get_theme()
584 );
585
586 $settings['__experimentalGlobalStylesBase'] = $global_styles;
587 }
588
589 // Add the styles for the editor via the settings
590 // so they get processed as if they were added via add_editor_styles:
591 // they will get the editor wrapper class.
592 $settings['styles'][] = array( 'css' => gutenberg_experimental_global_styles_get_stylesheet() );
593
594 return $settings;
595 }
596
597 /**
598 * Registers a Custom Post Type to store the user's origin config.
599 */
600 function gutenberg_experimental_global_styles_register_cpt() {
601 if ( ! gutenberg_experimental_global_styles_has_theme_json_support() ) {
602 return;
603 }
604
605 $args = array(
606 'label' => __( 'Global Styles', 'gutenberg' ),
607 'description' => 'CPT to store user design tokens',
608 'public' => false,
609 'show_ui' => false,
610 'show_in_rest' => true,
611 'rest_base' => '__experimental/global-styles',
612 'capabilities' => array(
613 'read' => 'edit_theme_options',
614 'create_posts' => 'edit_theme_options',
615 'edit_posts' => 'edit_theme_options',
616 'edit_published_posts' => 'edit_theme_options',
617 'delete_published_posts' => 'edit_theme_options',
618 'edit_others_posts' => 'edit_theme_options',
619 'delete_others_posts' => 'edit_theme_options',
620 ),
621 'map_meta_cap' => true,
622 'supports' => array(
623 'editor',
624 'revisions',
625 ),
626 );
627 register_post_type( 'wp_global_styles', $args );
628 }
629
630 add_action( 'init', 'gutenberg_experimental_global_styles_register_cpt' );
631 add_filter( 'block_editor_settings', 'gutenberg_experimental_global_styles_settings' );
632 add_action( 'wp_enqueue_scripts', 'gutenberg_experimental_global_styles_enqueue_assets' );
633