--- a/wp/wp-includes/class-wp-theme-json-resolver.php Thu Sep 29 08:06:27 2022 +0200
+++ b/wp/wp-includes/class-wp-theme-json-resolver.php Fri Sep 05 18:40:08 2025 +0200
@@ -13,13 +13,27 @@
*
* This class is for internal core usage and is not supposed to be used by extenders (plugins and/or themes).
* This is a low-level API that may need to do breaking changes. Please,
- * use get_global_settings, get_global_styles, and get_global_stylesheet instead.
+ * use get_global_settings(), get_global_styles(), and get_global_stylesheet() instead.
*
* @access private
*/
+#[AllowDynamicProperties]
class WP_Theme_JSON_Resolver {
/**
+ * Container for keep track of registered blocks.
+ *
+ * @since 6.1.0
+ * @var array
+ */
+ protected static $blocks_cache = array(
+ 'core' => array(),
+ 'blocks' => array(),
+ 'theme' => array(),
+ 'user' => array(),
+ );
+
+ /**
* Container for data coming from core.
*
* @since 5.8.0
@@ -28,6 +42,14 @@
protected static $core = null;
/**
+ * Container for data coming from the blocks.
+ *
+ * @since 6.1.0
+ * @var WP_Theme_JSON
+ */
+ protected static $blocks = null;
+
+ /**
* Container for data coming from the theme.
*
* @since 5.8.0
@@ -36,14 +58,6 @@
protected static $theme = null;
/**
- * Whether or not the theme supports theme.json.
- *
- * @since 5.8.0
- * @var bool
- */
- protected static $theme_has_support = null;
-
- /**
* Container for data coming from the user.
*
* @since 5.9.0
@@ -70,23 +84,37 @@
protected static $i18n_schema = null;
/**
+ * `theme.json` file cache.
+ *
+ * @since 6.1.0
+ * @var array
+ */
+ protected static $theme_json_file_cache = array();
+
+ /**
* Processes a file that adheres to the theme.json schema
* and returns an array with its contents, or a void array if none found.
*
* @since 5.8.0
+ * @since 6.1.0 Added caching.
*
* @param string $file_path Path to file. Empty if no file.
* @return array Contents that adhere to the theme.json schema.
*/
protected static function read_json_file( $file_path ) {
- $config = array();
if ( $file_path ) {
+ if ( array_key_exists( $file_path, static::$theme_json_file_cache ) ) {
+ return static::$theme_json_file_cache[ $file_path ];
+ }
+
$decoded_file = wp_json_file_decode( $file_path, array( 'associative' => true ) );
if ( is_array( $decoded_file ) ) {
- $config = $decoded_file;
+ static::$theme_json_file_cache[ $file_path ] = $decoded_file;
+ return static::$theme_json_file_cache[ $file_path ];
}
}
- return $config;
+
+ return array();
}
/**
@@ -130,18 +158,68 @@
* @return WP_Theme_JSON Entity that holds core data.
*/
public static function get_core_data() {
- if ( null !== static::$core ) {
+ if ( null !== static::$core && static::has_same_registered_blocks( 'core' ) ) {
return static::$core;
}
- $config = static::read_json_file( __DIR__ . '/theme.json' );
- $config = static::translate( $config );
- static::$core = new WP_Theme_JSON( $config, 'default' );
+ $config = static::read_json_file( __DIR__ . '/theme.json' );
+ $config = static::translate( $config );
+
+ /**
+ * Filters the default data provided by WordPress for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'wp_theme_json_data_default', new WP_Theme_JSON_Data( $config, 'default' ) );
+
+ /*
+ * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+ * compatible class that is not a WP_Theme_JSON_Data object.
+ */
+ if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+ static::$core = $theme_json->get_theme_json();
+ } else {
+ $config = $theme_json->get_data();
+ static::$core = new WP_Theme_JSON( $config, 'default' );
+ }
return static::$core;
}
/**
+ * Checks whether the registered blocks were already processed for this origin.
+ *
+ * @since 6.1.0
+ *
+ * @param string $origin Data source for which to cache the blocks.
+ * Valid values are 'core', 'blocks', 'theme', and 'user'.
+ * @return bool True on success, false otherwise.
+ */
+ protected static function has_same_registered_blocks( $origin ) {
+ // Bail out if the origin is invalid.
+ if ( ! isset( static::$blocks_cache[ $origin ] ) ) {
+ return false;
+ }
+
+ $registry = WP_Block_Type_Registry::get_instance();
+ $blocks = $registry->get_all_registered();
+
+ // Is there metadata for all currently registered blocks?
+ $block_diff = array_diff_key( $blocks, static::$blocks_cache[ $origin ] );
+ if ( empty( $block_diff ) ) {
+ return true;
+ }
+
+ foreach ( $blocks as $block_name => $block_type ) {
+ static::$blocks_cache[ $origin ][ $block_name ] = true;
+ }
+
+ return false;
+ }
+
+ /**
* Returns the theme's data.
*
* Data from theme.json will be backfilled from existing
@@ -152,6 +230,8 @@
* @since 5.8.0
* @since 5.9.0 Theme supports have been inlined and the `$theme_support_data` argument removed.
* @since 6.0.0 Added an `$options` parameter to allow the theme data to be returned without theme supports.
+ * @since 6.6.0 Add support for 'default-font-sizes' and 'default-spacing-sizes' theme supports.
+ * Added registration and merging of block style variations from partial theme.json files and the block styles registry.
*
* @param array $deprecated Deprecated. Not used.
* @param array $options {
@@ -168,21 +248,75 @@
$options = wp_parse_args( $options, array( 'with_supports' => true ) );
- if ( null === static::$theme ) {
- $theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json' ) );
- $theme_json_data = static::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
- static::$theme = new WP_Theme_JSON( $theme_json_data );
+ if ( null === static::$theme || ! static::has_same_registered_blocks( 'theme' ) ) {
+ $wp_theme = wp_get_theme();
+ $theme_json_file = $wp_theme->get_file_path( 'theme.json' );
+ if ( is_readable( $theme_json_file ) ) {
+ $theme_json_data = static::read_json_file( $theme_json_file );
+ $theme_json_data = static::translate( $theme_json_data, $wp_theme->get( 'TextDomain' ) );
+ } else {
+ $theme_json_data = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA );
+ }
+
+ /*
+ * Register variations defined by theme partials (theme.json files in the styles directory).
+ * This is required so the variations pass sanitization of theme.json data.
+ */
+ $variations = static::get_style_variations( 'block' );
+ wp_register_block_style_variations_from_theme_json_partials( $variations );
- if ( wp_get_theme()->parent() ) {
+ /*
+ * Source variations from the block registry and block style variation files. Then, merge them into the existing theme.json data.
+ *
+ * In case the same style properties are defined in several sources, this is how we should resolve the values,
+ * from higher to lower priority:
+ *
+ * - styles.blocks.blockType.variations from theme.json
+ * - styles.variations from theme.json
+ * - variations from block style variation files
+ * - variations from block styles registry
+ *
+ * See test_add_registered_block_styles_to_theme_data and test_unwraps_block_style_variations.
+ *
+ */
+ $theme_json_data = static::inject_variations_from_block_style_variation_files( $theme_json_data, $variations );
+ $theme_json_data = static::inject_variations_from_block_styles_registry( $theme_json_data );
+
+ /**
+ * Filters the data provided by the theme for global styles and settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'wp_theme_json_data_theme', new WP_Theme_JSON_Data( $theme_json_data, 'theme' ) );
+
+ /*
+ * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+ * compatible class that is not a WP_Theme_JSON_Data object.
+ */
+ if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+ static::$theme = $theme_json->get_theme_json();
+ } else {
+ $config = $theme_json->get_data();
+ static::$theme = new WP_Theme_JSON( $config );
+ }
+
+ if ( $wp_theme->parent() ) {
// Get parent theme.json.
- $parent_theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json', true ) );
- $parent_theme_json_data = static::translate( $parent_theme_json_data, wp_get_theme()->parent()->get( 'TextDomain' ) );
- $parent_theme = new WP_Theme_JSON( $parent_theme_json_data );
+ $parent_theme_json_file = $wp_theme->parent()->get_file_path( 'theme.json' );
+ if ( $theme_json_file !== $parent_theme_json_file && is_readable( $parent_theme_json_file ) ) {
+ $parent_theme_json_data = static::read_json_file( $parent_theme_json_file );
+ $parent_theme_json_data = static::translate( $parent_theme_json_data, $wp_theme->parent()->get( 'TextDomain' ) );
+ $parent_theme = new WP_Theme_JSON( $parent_theme_json_data );
- // Merge the child theme.json into the parent theme.json.
- // The child theme takes precedence over the parent.
- $parent_theme->merge( static::$theme );
- static::$theme = $parent_theme;
+ /*
+ * Merge the child theme.json into the parent theme.json.
+ * The child theme takes precedence over the parent.
+ */
+ $parent_theme->merge( static::$theme );
+ static::$theme = $parent_theme;
+ }
}
}
@@ -196,44 +330,136 @@
* So we take theme supports, transform it to theme.json shape
* and merge the static::$theme upon that.
*/
- $theme_support_data = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
- if ( ! static::theme_has_support() ) {
- if ( ! isset( $theme_support_data['settings']['color'] ) ) {
- $theme_support_data['settings']['color'] = array();
+ $theme_support_data = WP_Theme_JSON::get_from_editor_settings( get_classic_theme_supports_block_editor_settings() );
+ if ( ! wp_theme_has_theme_json() ) {
+ /*
+ * Unlike block themes, classic themes without a theme.json disable
+ * default presets when custom preset theme support is added. This
+ * behavior can be overridden by using the corresponding default
+ * preset theme support.
+ */
+ $theme_support_data['settings']['color']['defaultPalette'] =
+ ! isset( $theme_support_data['settings']['color']['palette'] ) ||
+ current_theme_supports( 'default-color-palette' );
+ $theme_support_data['settings']['color']['defaultGradients'] =
+ ! isset( $theme_support_data['settings']['color']['gradients'] ) ||
+ current_theme_supports( 'default-gradient-presets' );
+ $theme_support_data['settings']['typography']['defaultFontSizes'] =
+ ! isset( $theme_support_data['settings']['typography']['fontSizes'] ) ||
+ current_theme_supports( 'default-font-sizes' );
+ $theme_support_data['settings']['spacing']['defaultSpacingSizes'] =
+ ! isset( $theme_support_data['settings']['spacing']['spacingSizes'] ) ||
+ current_theme_supports( 'default-spacing-sizes' );
+
+ /*
+ * Shadow presets are explicitly disabled for classic themes until a
+ * decision is made for whether the default presets should match the
+ * other presets or if they should be disabled by default in classic
+ * themes. See https://github.com/WordPress/gutenberg/issues/59989.
+ */
+ $theme_support_data['settings']['shadow']['defaultPresets'] = false;
+
+ // Allow themes to enable link color setting via theme_support.
+ if ( current_theme_supports( 'link-color' ) ) {
+ $theme_support_data['settings']['color']['link'] = true;
}
- $default_palette = false;
- if ( current_theme_supports( 'default-color-palette' ) ) {
- $default_palette = true;
+ // Allow themes to enable all border settings via theme_support.
+ if ( current_theme_supports( 'border' ) ) {
+ $theme_support_data['settings']['border']['color'] = true;
+ $theme_support_data['settings']['border']['radius'] = true;
+ $theme_support_data['settings']['border']['style'] = true;
+ $theme_support_data['settings']['border']['width'] = true;
}
- if ( ! isset( $theme_support_data['settings']['color']['palette'] ) ) {
- // If the theme does not have any palette, we still want to show the core one.
- $default_palette = true;
- }
- $theme_support_data['settings']['color']['defaultPalette'] = $default_palette;
- $default_gradients = false;
- if ( current_theme_supports( 'default-gradient-presets' ) ) {
- $default_gradients = true;
+ // Allow themes to enable appearance tools via theme_support.
+ if ( current_theme_supports( 'appearance-tools' ) ) {
+ $theme_support_data['settings']['appearanceTools'] = true;
}
- if ( ! isset( $theme_support_data['settings']['color']['gradients'] ) ) {
- // If the theme does not have any gradients, we still want to show the core ones.
- $default_gradients = true;
- }
- $theme_support_data['settings']['color']['defaultGradients'] = $default_gradients;
-
- // Classic themes without a theme.json don't support global duotone.
- $theme_support_data['settings']['color']['defaultDuotone'] = false;
}
$with_theme_supports = new WP_Theme_JSON( $theme_support_data );
$with_theme_supports->merge( static::$theme );
-
return $with_theme_supports;
}
/**
+ * Gets the styles for blocks from the block.json file.
+ *
+ * @since 6.1.0
+ *
+ * @return WP_Theme_JSON
+ */
+ public static function get_block_data() {
+ $registry = WP_Block_Type_Registry::get_instance();
+ $blocks = $registry->get_all_registered();
+
+ if ( null !== static::$blocks && static::has_same_registered_blocks( 'blocks' ) ) {
+ return static::$blocks;
+ }
+
+ $config = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA );
+ foreach ( $blocks as $block_name => $block_type ) {
+ if ( isset( $block_type->supports['__experimentalStyle'] ) ) {
+ $config['styles']['blocks'][ $block_name ] = static::remove_json_comments( $block_type->supports['__experimentalStyle'] );
+ }
+
+ if (
+ isset( $block_type->supports['spacing']['blockGap']['__experimentalDefault'] ) &&
+ ! isset( $config['styles']['blocks'][ $block_name ]['spacing']['blockGap'] )
+ ) {
+ /*
+ * Ensure an empty placeholder value exists for the block, if it provides a default blockGap value.
+ * The real blockGap value to be used will be determined when the styles are rendered for output.
+ */
+ $config['styles']['blocks'][ $block_name ]['spacing']['blockGap'] = null;
+ }
+ }
+
+ /**
+ * Filters the data provided by the blocks for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'wp_theme_json_data_blocks', new WP_Theme_JSON_Data( $config, 'blocks' ) );
+
+ /*
+ * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+ * compatible class that is not a WP_Theme_JSON_Data object.
+ */
+ if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+ static::$blocks = $theme_json->get_theme_json();
+ } else {
+ $config = $theme_json->get_data();
+ static::$blocks = new WP_Theme_JSON( $config, 'blocks' );
+ }
+
+ return static::$blocks;
+ }
+
+ /**
+ * When given an array, this will remove any keys with the name `//`.
+ *
+ * @since 6.1.0
+ *
+ * @param array $input_array The array to filter.
+ * @return array The filtered array.
+ */
+ private static function remove_json_comments( $input_array ) {
+ unset( $input_array['//'] );
+ foreach ( $input_array as $k => $v ) {
+ if ( is_array( $v ) ) {
+ $input_array[ $k ] = static::remove_json_comments( $v );
+ }
+ }
+
+ return $input_array;
+ }
+
+ /**
* Returns the custom post type that contains the user's origin config
- * for the active theme or a void array if none are found.
+ * for the active theme or an empty array if none are found.
*
* This can also create and return a new draft custom post type.
*
@@ -253,56 +479,62 @@
if ( ! $theme instanceof WP_Theme ) {
$theme = wp_get_theme();
}
+
+ /*
+ * Bail early if the theme does not support a theme.json.
+ *
+ * Since wp_theme_has_theme_json() only supports the active
+ * theme, the extra condition for whether $theme is the active theme is
+ * present here.
+ */
+ if ( $theme->get_stylesheet() === get_stylesheet() && ! wp_theme_has_theme_json() ) {
+ return array();
+ }
+
$user_cpt = array();
$post_type_filter = 'wp_global_styles';
+ $stylesheet = $theme->get_stylesheet();
$args = array(
- 'numberposts' => 1,
- 'orderby' => 'date',
- 'order' => 'desc',
- 'post_type' => $post_type_filter,
- 'post_status' => $post_status_filter,
- 'tax_query' => array(
+ 'posts_per_page' => 1,
+ 'orderby' => 'date',
+ 'order' => 'desc',
+ 'post_type' => $post_type_filter,
+ 'post_status' => $post_status_filter,
+ 'ignore_sticky_posts' => true,
+ 'no_found_rows' => true,
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'tax_query' => array(
array(
'taxonomy' => 'wp_theme',
'field' => 'name',
- 'terms' => $theme->get_stylesheet(),
+ 'terms' => $stylesheet,
),
),
);
- $cache_key = sprintf( 'wp_global_styles_%s', md5( serialize( $args ) ) );
- $post_id = wp_cache_get( $cache_key );
-
- if ( (int) $post_id > 0 ) {
- return get_post( $post_id, ARRAY_A );
- }
-
- // Special case: '-1' is a results not found.
- if ( -1 === $post_id && ! $create_post ) {
- return $user_cpt;
- }
-
- $recent_posts = wp_get_recent_posts( $args );
- if ( is_array( $recent_posts ) && ( count( $recent_posts ) === 1 ) ) {
- $user_cpt = $recent_posts[0];
+ $global_style_query = new WP_Query();
+ $recent_posts = $global_style_query->query( $args );
+ if ( count( $recent_posts ) === 1 ) {
+ $user_cpt = get_object_vars( $recent_posts[0] );
} elseif ( $create_post ) {
$cpt_post_id = wp_insert_post(
array(
'post_content' => '{"version": ' . WP_Theme_JSON::LATEST_SCHEMA . ', "isGlobalStylesUserThemeJSON": true }',
'post_status' => 'publish',
- 'post_title' => 'Custom Styles',
+ 'post_title' => 'Custom Styles', // Do not make string translatable, see https://core.trac.wordpress.org/ticket/54518.
'post_type' => $post_type_filter,
- 'post_name' => 'wp-global-styles-' . urlencode( wp_get_theme()->get_stylesheet() ),
+ 'post_name' => sprintf( 'wp-global-styles-%s', urlencode( $stylesheet ) ),
'tax_input' => array(
- 'wp_theme' => array( wp_get_theme()->get_stylesheet() ),
+ 'wp_theme' => array( $stylesheet ),
),
),
true
);
- $user_cpt = get_post( $cpt_post_id, ARRAY_A );
+ if ( ! is_wp_error( $cpt_post_id ) ) {
+ $user_cpt = get_object_vars( get_post( $cpt_post_id ) );
+ }
}
- $cache_expiration = $user_cpt ? DAY_IN_SECONDS : HOUR_IN_SECONDS;
- wp_cache_set( $cache_key, $user_cpt ? $user_cpt['ID'] : -1, '', $cache_expiration );
return $user_cpt;
}
@@ -311,11 +543,13 @@
* Returns the user's origin config.
*
* @since 5.9.0
+ * @since 6.6.0 The 'isGlobalStylesUserThemeJSON' flag is left on the user data.
+ * Register the block style variations coming from the user data.
*
* @return WP_Theme_JSON Entity that holds styles for user data.
*/
public static function get_user_data() {
- if ( null !== static::$user ) {
+ if ( null !== static::$user && static::has_same_registered_blocks( 'user' ) ) {
return static::$user;
}
@@ -327,12 +561,32 @@
$json_decoding_error = json_last_error();
if ( JSON_ERROR_NONE !== $json_decoding_error ) {
- trigger_error( 'Error when decoding a theme.json schema for user data. ' . json_last_error_msg() );
- return new WP_Theme_JSON( $config, 'custom' );
+ wp_trigger_error( __METHOD__, 'Error when decoding a theme.json schema for user data. ' . json_last_error_msg() );
+ /**
+ * Filters the data provided by the user for global styles & settings.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
+ */
+ $theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+
+ /*
+ * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+ * compatible class that is not a WP_Theme_JSON_Data object.
+ */
+ if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+ return $theme_json->get_theme_json();
+ } else {
+ $config = $theme_json->get_data();
+ return new WP_Theme_JSON( $config, 'custom' );
+ }
}
- // Very important to verify that the flag isGlobalStylesUserThemeJSON is true.
- // If it's not true then the content was not escaped and is not safe.
+ /*
+ * Very important to verify that the flag isGlobalStylesUserThemeJSON is true.
+ * If it's not true then the content was not escaped and is not safe.
+ */
if (
is_array( $decoded_data ) &&
isset( $decoded_data['isGlobalStylesUserThemeJSON'] ) &&
@@ -342,7 +596,20 @@
$config = $decoded_data;
}
}
- static::$user = new WP_Theme_JSON( $config, 'custom' );
+
+ /** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */
+ $theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+
+ /*
+ * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+ * compatible class that is not a WP_Theme_JSON_Data object.
+ */
+ if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+ static::$user = $theme_json->get_theme_json();
+ } else {
+ $config = $theme_json->get_data();
+ static::$user = new WP_Theme_JSON( $config, 'custom' );
+ }
return static::$user;
}
@@ -350,9 +617,15 @@
/**
* Returns the data merged from multiple origins.
*
- * There are three sources of data (origins) for a site:
- * default, theme, and custom. The custom's has higher priority
- * than the theme's, and the theme's higher than default's.
+ * There are four sources of data (origins) for a site:
+ *
+ * - default => WordPress
+ * - blocks => each one of the blocks provides data for itself
+ * - theme => the active theme
+ * - custom => data provided by the user
+ *
+ * The custom's has higher priority than the theme's, the theme's higher than blocks',
+ * and block's higher than default's.
*
* Unlike the getters
* {@link https://developer.wordpress.org/reference/classes/wp_theme_json_resolver/get_core_data/ get_core_data},
@@ -360,7 +633,7 @@
* and {@link https://developer.wordpress.org/reference/classes/wp_theme_json_resolver/get_user_data/ get_user_data},
* this method returns data after it has been merged with the previous origins.
* This means that if the same piece of data is declared in different origins
- * (user, theme, and core), the last origin overrides the previous.
+ * (default, blocks, theme, custom), the last origin overrides the previous.
*
* For example, if the user has set a background color
* for the paragraph block, and the theme has done it as well,
@@ -369,9 +642,11 @@
* @since 5.8.0
* @since 5.9.0 Added user data, removed the `$settings` parameter,
* added the `$origin` parameter.
+ * @since 6.1.0 Added block data and generation of spacingSizes array.
+ * @since 6.2.0 Changed ' $origin' parameter values to 'default', 'blocks', 'theme' or 'custom'.
*
- * @param string $origin Optional. To what level should we merge data.
- * Valid values are 'theme' or 'custom'. Default 'custom'.
+ * @param string $origin Optional. To what level should we merge data: 'default', 'blocks', 'theme' or 'custom'.
+ * 'custom' is used as default value as well as fallback value if the origin is unknown.
* @return WP_Theme_JSON
*/
public static function get_merged_data( $origin = 'custom' ) {
@@ -381,12 +656,22 @@
$result = new WP_Theme_JSON();
$result->merge( static::get_core_data() );
- $result->merge( static::get_theme_data() );
+ if ( 'default' === $origin ) {
+ return $result;
+ }
- if ( 'custom' === $origin ) {
- $result->merge( static::get_user_data() );
+ $result->merge( static::get_block_data() );
+ if ( 'blocks' === $origin ) {
+ return $result;
}
+ $result->merge( static::get_theme_data() );
+ if ( 'theme' === $origin ) {
+ return $result;
+ }
+
+ $result->merge( static::get_user_data() );
+
return $result;
}
@@ -417,18 +702,14 @@
*
* @since 5.8.0
* @since 5.9.0 Added a check in the parent theme.
+ * @deprecated 6.2.0 Use wp_theme_has_theme_json() instead.
*
* @return bool
*/
public static function theme_has_support() {
- if ( ! isset( static::$theme_has_support ) ) {
- static::$theme_has_support = (
- is_readable( static::get_file_path_from_theme( 'theme.json' ) ) ||
- is_readable( static::get_file_path_from_theme( 'theme.json', true ) )
- );
- }
+ _deprecated_function( __METHOD__, '6.2.0', 'wp_theme_has_theme_json()' );
- return static::$theme_has_support;
+ return wp_theme_has_theme_json();
}
/**
@@ -456,43 +737,266 @@
* @since 5.8.0
* @since 5.9.0 Added the `$user`, `$user_custom_post_type_id`,
* and `$i18n_schema` variables to reset.
+ * @since 6.1.0 Added the `$blocks` and `$blocks_cache` variables
+ * to reset.
*/
public static function clean_cached_data() {
static::$core = null;
+ static::$blocks = null;
+ static::$blocks_cache = array(
+ 'core' => array(),
+ 'blocks' => array(),
+ 'theme' => array(),
+ 'user' => array(),
+ );
static::$theme = null;
static::$user = null;
static::$user_custom_post_type_id = null;
- static::$theme_has_support = null;
static::$i18n_schema = null;
}
/**
+ * Returns an array of all nested JSON files within a given directory.
+ *
+ * @since 6.2.0
+ *
+ * @param string $dir The directory to recursively iterate and list files of.
+ * @return array The merged array.
+ */
+ private static function recursively_iterate_json( $dir ) {
+ $nested_files = new RecursiveIteratorIterator( new RecursiveDirectoryIterator( $dir ) );
+ $nested_json_files = iterator_to_array( new RegexIterator( $nested_files, '/^.+\.json$/i', RecursiveRegexIterator::GET_MATCH ) );
+ return $nested_json_files;
+ }
+
+ /**
+ * Determines if a supplied style variation matches the provided scope.
+ *
+ * For backwards compatibility, if a variation does not define any scope
+ * related property, e.g. `blockTypes`, it is assumed to be a theme style
+ * variation.
+ *
+ * @since 6.6.0
+ *
+ * @param array $variation Theme.json shaped style variation object.
+ * @param string $scope Scope to check e.g. theme, block etc.
+ * @return boolean
+ */
+ private static function style_variation_has_scope( $variation, $scope ) {
+ if ( 'block' === $scope ) {
+ return isset( $variation['blockTypes'] );
+ }
+
+ if ( 'theme' === $scope ) {
+ return ! isset( $variation['blockTypes'] );
+ }
+
+ return false;
+ }
+
+ /**
* Returns the style variations defined by the theme.
*
* @since 6.0.0
+ * @since 6.2.0 Returns parent theme variations if theme is a child.
+ * @since 6.6.0 Added configurable scope parameter to allow filtering
+ * theme.json partial files by the scope to which they
+ * can be applied e.g. theme vs block etc.
+ * Added basic caching for read theme.json partial files.
*
+ * @param string $scope The scope or type of style variation to retrieve e.g. theme, block etc.
* @return array
*/
- public static function get_style_variations() {
- $variations = array();
- $base_directory = get_stylesheet_directory() . '/styles';
+ public static function get_style_variations( $scope = 'theme' ) {
+ $variation_files = array();
+ $variations = array();
+ $base_directory = get_stylesheet_directory() . '/styles';
+ $template_directory = get_template_directory() . '/styles';
if ( is_dir( $base_directory ) ) {
- $nested_files = new RecursiveIteratorIterator( new RecursiveDirectoryIterator( $base_directory ) );
- $nested_html_files = iterator_to_array( new RegexIterator( $nested_files, '/^.+\.json$/i', RecursiveRegexIterator::GET_MATCH ) );
- ksort( $nested_html_files );
- foreach ( $nested_html_files as $path => $file ) {
- $decoded_file = wp_json_file_decode( $path, array( 'associative' => true ) );
- if ( is_array( $decoded_file ) ) {
- $translated = static::translate( $decoded_file, wp_get_theme()->get( 'TextDomain' ) );
- $variation = ( new WP_Theme_JSON( $translated ) )->get_raw_data();
- if ( empty( $variation['title'] ) ) {
- $variation['title'] = basename( $path, '.json' );
+ $variation_files = static::recursively_iterate_json( $base_directory );
+ }
+ if ( is_dir( $template_directory ) && $template_directory !== $base_directory ) {
+ $variation_files_parent = static::recursively_iterate_json( $template_directory );
+ // If the child and parent variation file basename are the same, only include the child theme's.
+ foreach ( $variation_files_parent as $parent_path => $parent ) {
+ foreach ( $variation_files as $child_path => $child ) {
+ if ( basename( $parent_path ) === basename( $child_path ) ) {
+ unset( $variation_files_parent[ $parent_path ] );
}
- $variations[] = $variation;
}
}
+ $variation_files = array_merge( $variation_files, $variation_files_parent );
+ }
+ ksort( $variation_files );
+ foreach ( $variation_files as $path => $file ) {
+ $decoded_file = self::read_json_file( $path );
+ if ( is_array( $decoded_file ) && static::style_variation_has_scope( $decoded_file, $scope ) ) {
+ $translated = static::translate( $decoded_file, wp_get_theme()->get( 'TextDomain' ) );
+ $variation = ( new WP_Theme_JSON( $translated ) )->get_raw_data();
+ if ( empty( $variation['title'] ) ) {
+ $variation['title'] = basename( $path, '.json' );
+ }
+ $variations[] = $variation;
+ }
}
return $variations;
}
+ /**
+ * Resolves relative paths in theme.json styles to theme absolute paths
+ * and returns them in an array that can be embedded
+ * as the value of `_link` object in REST API responses.
+ *
+ * @since 6.6.0
+ *
+ * @param WP_Theme_JSON $theme_json A theme json instance.
+ * @return array An array of resolved paths.
+ */
+ public static function get_resolved_theme_uris( $theme_json ) {
+ $resolved_theme_uris = array();
+
+ if ( ! $theme_json instanceof WP_Theme_JSON ) {
+ return $resolved_theme_uris;
+ }
+
+ $theme_json_data = $theme_json->get_raw_data();
+
+ // Top level styles.
+ $background_image_url = isset( $theme_json_data['styles']['background']['backgroundImage']['url'] ) ? $theme_json_data['styles']['background']['backgroundImage']['url'] : null;
+
+ /*
+ * The same file convention when registering web fonts.
+ * See: WP_Font_Face_Resolver::to_theme_file_uri.
+ */
+ $placeholder = 'file:./';
+ if (
+ isset( $background_image_url ) &&
+ is_string( $background_image_url ) &&
+ // Skip if the src doesn't start with the placeholder, as there's nothing to replace.
+ str_starts_with( $background_image_url, $placeholder )
+ ) {
+ $file_type = wp_check_filetype( $background_image_url );
+ $src_url = str_replace( $placeholder, '', $background_image_url );
+ $resolved_theme_uri = array(
+ 'name' => $background_image_url,
+ 'href' => sanitize_url( get_theme_file_uri( $src_url ) ),
+ 'target' => 'styles.background.backgroundImage.url',
+ );
+ if ( isset( $file_type['type'] ) ) {
+ $resolved_theme_uri['type'] = $file_type['type'];
+ }
+ $resolved_theme_uris[] = $resolved_theme_uri;
+ }
+
+ return $resolved_theme_uris;
+ }
+
+ /**
+ * Resolves relative paths in theme.json styles to theme absolute paths
+ * and merges them with incoming theme JSON.
+ *
+ * @since 6.6.0
+ *
+ * @param WP_Theme_JSON $theme_json A theme json instance.
+ * @return WP_Theme_JSON Theme merged with resolved paths, if any found.
+ */
+ public static function resolve_theme_file_uris( $theme_json ) {
+ $resolved_urls = static::get_resolved_theme_uris( $theme_json );
+ if ( empty( $resolved_urls ) ) {
+ return $theme_json;
+ }
+
+ $resolved_theme_json_data = array(
+ 'version' => WP_Theme_JSON::LATEST_SCHEMA,
+ );
+
+ foreach ( $resolved_urls as $resolved_url ) {
+ $path = explode( '.', $resolved_url['target'] );
+ _wp_array_set( $resolved_theme_json_data, $path, $resolved_url['href'] );
+ }
+
+ $theme_json->merge( new WP_Theme_JSON( $resolved_theme_json_data ) );
+
+ return $theme_json;
+ }
+
+ /**
+ * Adds variations sourced from block style variations files to the supplied theme.json data.
+ *
+ * @since 6.6.0
+ *
+ * @param array $data Array following the theme.json specification.
+ * @param array $variations Shared block style variations.
+ * @return array Theme json data including shared block style variation definitions.
+ */
+ private static function inject_variations_from_block_style_variation_files( $data, $variations ) {
+ if ( empty( $variations ) ) {
+ return $data;
+ }
+
+ foreach ( $variations as $variation ) {
+ if ( empty( $variation['styles'] ) || empty( $variation['blockTypes'] ) ) {
+ continue;
+ }
+
+ $variation_name = $variation['slug'] ?? _wp_to_kebab_case( $variation['title'] );
+
+ foreach ( $variation['blockTypes'] as $block_type ) {
+ // First, override partial styles with any top-level styles.
+ $top_level_data = $data['styles']['variations'][ $variation_name ] ?? array();
+ if ( ! empty( $top_level_data ) ) {
+ $variation['styles'] = array_replace_recursive( $variation['styles'], $top_level_data );
+ }
+
+ // Then, override styles so far with any block-level styles.
+ $block_level_data = $data['styles']['blocks'][ $block_type ]['variations'][ $variation_name ] ?? array();
+ if ( ! empty( $block_level_data ) ) {
+ $variation['styles'] = array_replace_recursive( $variation['styles'], $block_level_data );
+ }
+
+ $path = array( 'styles', 'blocks', $block_type, 'variations', $variation_name );
+ _wp_array_set( $data, $path, $variation['styles'] );
+ }
+ }
+
+ return $data;
+ }
+
+ /**
+ * Adds variations sourced from the block styles registry to the supplied theme.json data.
+ *
+ * @since 6.6.0
+ *
+ * @param array $data Array following the theme.json specification.
+ * @return array Theme json data including shared block style variation definitions.
+ */
+ private static function inject_variations_from_block_styles_registry( $data ) {
+ $registry = WP_Block_Styles_Registry::get_instance();
+ $styles = $registry->get_all_registered();
+
+ foreach ( $styles as $block_type => $variations ) {
+ foreach ( $variations as $variation_name => $variation ) {
+ if ( empty( $variation['style_data'] ) ) {
+ continue;
+ }
+
+ // First, override registry styles with any top-level styles.
+ $top_level_data = $data['styles']['variations'][ $variation_name ] ?? array();
+ if ( ! empty( $top_level_data ) ) {
+ $variation['style_data'] = array_replace_recursive( $variation['style_data'], $top_level_data );
+ }
+
+ // Then, override styles so far with any block-level styles.
+ $block_level_data = $data['styles']['blocks'][ $block_type ]['variations'][ $variation_name ] ?? array();
+ if ( ! empty( $block_level_data ) ) {
+ $variation['style_data'] = array_replace_recursive( $variation['style_data'], $block_level_data );
+ }
+
+ $path = array( 'styles', 'blocks', $block_type, 'variations', $variation_name );
+ _wp_array_set( $data, $path, $variation['style_data'] );
+ }
+ }
+
+ return $data;
+ }
}