mirror of
https://github.com/WordPress/WordPress.git
synced 2024-11-05 02:10:45 +01:00
e4b553a201
Update packages to include these bug fixes from Gutenberg: - Update Pattern block category and add documentation - Fix non existent menu handling in nav block - Make Reusable blocks available in the Site Editor - Add caching to WP_Theme_JSON_Resolver_Gutenberg::get_user_data_from_custom_post_type() - theme.json: add appearanceTools flag to opt-in into appearance UI controls - Update the block theme folders to templates and parts - Remove reference to gutenberg_, swap with wp_ - Use table layout in templates list screen - Update featured image placeholder graphic. - [Inserter]: Adjust order of theme blocks and reorder inserter items - Implement suitable fallback for Nav block on front end of site when no menu selected - Toggle Group Control: add tooltip - Use first non-empty Nav post as primary fallback for Nav block - Change .nvmrc and documentation for Node.js version (LTS to 14.18.1) - Update: Migrate global styles user database data on the rest endpoint - Update global styles public API - Update: Rename user preset origin to custom - Try always generating navigation post title - Show all templates and template parts on the site editor list screens - Highlight "Site" in the navigation panel - Fix template part slug generation when creating through the block placeholder - [Block Library - Post Title]: Fix render error when setting Page to homepage - Add 'Clear customizations' button to template list page - Gallery v1: Allow clicks within replace media placeholder state - Site Editor: Set the <title> on the list page to be same as the CPT name - Gallery: Fix stuck image size options loader - Cover: Fix undo trap - Add success and error snackbars to the templates list page - Fix: theme colors cannot override defaults - Fix: Color palette is not being stored - Add elements support to the typography panel in global styles - Make links plural in global styles - Add: Gradient palette editor - Update some small style regressions in the template list - Add: Transparency support on global styles colors - Fix: apply by slug on all origins - Render empty Nav block if no fallback block can be utilised - Allow filtering of Nav block fallback - Fix Nav block fallback DB query to match on full block grammar start tag - Remove unstable max pages attribute from Nav block - DateTimePicker: set PM hours correctly - Update delete template button - Site Editor: Template list add rename action - Fix Nav block editing wrong entity on creation of new Menu - [REST] Restore the missing double slash in the ID received by /templates - Add icons to navigation sidebar items - Update function names for the public global styles API functions - Templates Controller: Add missing 'is_custom' prop - Rename gutenberg_ to wp_ for some functions that land in WordPress 5.9 - [Block Library - Template Part]:Remove support for conversion to Reusable block - Global Styles: Call "palettes" and not "color palettes" on panel label - Add button text when no colors found - Update: Global Styes: Count all color palette origins on the palette counter - Rename navigationMenuId to ref - Offset the parent iframe when computing Popover position - Fix: Failing PHPUnit test - Show theme, plugin or author in Added By column with appropriate icon or avatar - Add origin and author to template rest api See #54487. Props talldanwp, mamaduka, oandregal. Built from https://develop.svn.wordpress.org/trunk@52275 git-svn-id: http://core.svn.wordpress.org/trunk@51867 1a063a9b-81f0-0310-95a4-ce76da25c4cd
1855 lines
55 KiB
PHP
1855 lines
55 KiB
PHP
<?php
|
|
/**
|
|
* WP_Theme_JSON class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Theme
|
|
* @since 5.8.0
|
|
*/
|
|
|
|
/**
|
|
* Class that encapsulates the processing of structures that adhere to the theme.json spec.
|
|
*
|
|
* 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.
|
|
*
|
|
* @access private
|
|
*/
|
|
class WP_Theme_JSON {
|
|
|
|
/**
|
|
* Container of data in theme.json format.
|
|
*
|
|
* @since 5.8.0
|
|
* @var array
|
|
*/
|
|
private $theme_json = null;
|
|
|
|
/**
|
|
* Holds block metadata extracted from block.json
|
|
* to be shared among all instances so we don't
|
|
* process it twice.
|
|
*
|
|
* @since 5.8.0
|
|
* @var array
|
|
*/
|
|
private static $blocks_metadata = null;
|
|
|
|
/**
|
|
* The CSS selector for the top-level styles.
|
|
*
|
|
* @since 5.8.0
|
|
* @var string
|
|
*/
|
|
const ROOT_BLOCK_SELECTOR = 'body';
|
|
|
|
/**
|
|
* The sources of data this object can represent.
|
|
*
|
|
* @since 5.8.0
|
|
* @var string[]
|
|
*/
|
|
const VALID_ORIGINS = array(
|
|
'default',
|
|
'theme',
|
|
'custom',
|
|
);
|
|
|
|
/**
|
|
* Presets are a set of values that serve
|
|
* to bootstrap some styles: colors, font sizes, etc.
|
|
*
|
|
* They are a unkeyed array of values such as:
|
|
*
|
|
* ```php
|
|
* array(
|
|
* array(
|
|
* 'slug' => 'unique-name-within-the-set',
|
|
* 'name' => 'Name for the UI',
|
|
* <value_key> => 'value'
|
|
* ),
|
|
* )
|
|
* ```
|
|
*
|
|
* This contains the necessary metadata to process them:
|
|
*
|
|
* - path => where to find the preset within the settings section
|
|
* - override => whether a theme preset with the same slug as a default preset
|
|
* can override it
|
|
* - value_key => the key that represents the value
|
|
* - value_func => optionally, instead of value_key, a function to generate
|
|
* the value that takes a preset as an argument
|
|
* (either value_key or value_func should be present)
|
|
* - css_vars => template string to use in generating the CSS Custom Property.
|
|
* Example output: "--wp--preset--duotone--blue: <value>" will generate as many CSS Custom Properties as presets defined
|
|
* substituting the $slug for the slug's value for each preset value.
|
|
* - classes => array containing a structure with the classes to
|
|
* generate for the presets, where for each array item
|
|
* the key is the class name and the value the property name.
|
|
* The "$slug" substring will be replaced by the slug of each preset.
|
|
* For example:
|
|
* 'classes' => array(
|
|
* '.has-$slug-color' => 'color',
|
|
* '.has-$slug-background-color' => 'background-color',
|
|
* '.has-$slug-border-color' => 'border-color',
|
|
* )
|
|
* - properties => array of CSS properties to be used by kses to
|
|
* validate the content of each preset
|
|
* by means of the remove_insecure_properties method.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Added new presets and simplified the metadata structure.
|
|
* @var array
|
|
*/
|
|
const PRESETS_METADATA = array(
|
|
array(
|
|
'path' => array( 'color', 'palette' ),
|
|
'override' => false,
|
|
'value_key' => 'color',
|
|
'css_vars' => '--wp--preset--color--$slug',
|
|
'classes' => array(
|
|
'.has-$slug-color' => 'color',
|
|
'.has-$slug-background-color' => 'background-color',
|
|
'.has-$slug-border-color' => 'border-color',
|
|
),
|
|
'properties' => array( 'color', 'background-color', 'border-color' ),
|
|
),
|
|
array(
|
|
'path' => array( 'color', 'gradients' ),
|
|
'override' => false,
|
|
'value_key' => 'gradient',
|
|
'css_vars' => '--wp--preset--gradient--$slug',
|
|
'classes' => array( '.has-$slug-gradient-background' => 'background' ),
|
|
'properties' => array( 'background' ),
|
|
),
|
|
array(
|
|
'path' => array( 'color', 'duotone' ),
|
|
'override' => true,
|
|
'value_func' => 'wp_render_duotone_filter_preset',
|
|
'css_vars' => '--wp--preset--duotone--$slug',
|
|
'classes' => array(),
|
|
'properties' => array( 'filter' ),
|
|
),
|
|
array(
|
|
'path' => array( 'typography', 'fontSizes' ),
|
|
'override' => true,
|
|
'value_key' => 'size',
|
|
'css_vars' => '--wp--preset--font-size--$slug',
|
|
'classes' => array( '.has-$slug-font-size' => 'font-size' ),
|
|
'properties' => array( 'font-size' ),
|
|
),
|
|
array(
|
|
'path' => array( 'typography', 'fontFamilies' ),
|
|
'override' => true,
|
|
'value_key' => 'fontFamily',
|
|
'css_vars' => '--wp--preset--font-family--$slug',
|
|
'classes' => array( '.has-$slug-font-family' => 'font-family' ),
|
|
'properties' => array( 'font-family' ),
|
|
),
|
|
);
|
|
|
|
/**
|
|
* Metadata for style properties.
|
|
*
|
|
* Each element is a direct mapping from the CSS property name to the
|
|
* path to the value in theme.json & block attributes.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Added new properties and simplified the metadata structure.
|
|
* @var array
|
|
*/
|
|
const PROPERTIES_METADATA = array(
|
|
'background' => array( 'color', 'gradient' ),
|
|
'background-color' => array( 'color', 'background' ),
|
|
'border-radius' => array( 'border', 'radius' ),
|
|
'border-top-left-radius' => array( 'border', 'radius', 'topLeft' ),
|
|
'border-top-right-radius' => array( 'border', 'radius', 'topRight' ),
|
|
'border-bottom-left-radius' => array( 'border', 'radius', 'bottomLeft' ),
|
|
'border-bottom-right-radius' => array( 'border', 'radius', 'bottomRight' ),
|
|
'border-color' => array( 'border', 'color' ),
|
|
'border-width' => array( 'border', 'width' ),
|
|
'border-style' => array( 'border', 'style' ),
|
|
'color' => array( 'color', 'text' ),
|
|
'font-family' => array( 'typography', 'fontFamily' ),
|
|
'font-size' => array( 'typography', 'fontSize' ),
|
|
'font-style' => array( 'typography', 'fontStyle' ),
|
|
'font-weight' => array( 'typography', 'fontWeight' ),
|
|
'letter-spacing' => array( 'typography', 'letterSpacing' ),
|
|
'line-height' => array( 'typography', 'lineHeight' ),
|
|
'margin' => array( 'spacing', 'margin' ),
|
|
'margin-top' => array( 'spacing', 'margin', 'top' ),
|
|
'margin-right' => array( 'spacing', 'margin', 'right' ),
|
|
'margin-bottom' => array( 'spacing', 'margin', 'bottom' ),
|
|
'margin-left' => array( 'spacing', 'margin', 'left' ),
|
|
'padding' => array( 'spacing', 'padding' ),
|
|
'padding-top' => array( 'spacing', 'padding', 'top' ),
|
|
'padding-right' => array( 'spacing', 'padding', 'right' ),
|
|
'padding-bottom' => array( 'spacing', 'padding', 'bottom' ),
|
|
'padding-left' => array( 'spacing', 'padding', 'left' ),
|
|
'--wp--style--block-gap' => array( 'spacing', 'blockGap' ),
|
|
'text-decoration' => array( 'typography', 'textDecoration' ),
|
|
'text-transform' => array( 'typography', 'textTransform' ),
|
|
'filter' => array( 'filter', 'duotone' ),
|
|
);
|
|
|
|
/**
|
|
* Protected style properties.
|
|
*
|
|
* These style properties are only rendered if a setting enables it
|
|
* via a value other than `null`.
|
|
*
|
|
* Each element maps the style property to the corresponding theme.json
|
|
* setting key.
|
|
*
|
|
* @since 5.9.0
|
|
*/
|
|
const PROTECTED_PROPERTIES = array(
|
|
'spacing.blockGap' => array( 'spacing', 'blockGap' ),
|
|
);
|
|
|
|
/**
|
|
* The top-level keys a theme.json can have.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Renamed from ALLOWED_TOP_LEVEL_KEYS and added new values.
|
|
* @var string[]
|
|
*/
|
|
const VALID_TOP_LEVEL_KEYS = array(
|
|
'customTemplates',
|
|
'settings',
|
|
'styles',
|
|
'templateParts',
|
|
'version',
|
|
);
|
|
|
|
/**
|
|
* The valid properties under the settings key.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Renamed from ALLOWED_SETTINGS, gained new properties, and renamed others according to the new schema.
|
|
* @var array
|
|
*/
|
|
const VALID_SETTINGS = array(
|
|
'appearanceTools' => null,
|
|
'border' => array(
|
|
'color' => null,
|
|
'radius' => null,
|
|
'style' => null,
|
|
'width' => null,
|
|
),
|
|
'color' => array(
|
|
'background' => null,
|
|
'custom' => null,
|
|
'customDuotone' => null,
|
|
'customGradient' => null,
|
|
'defaultGradients' => null,
|
|
'defaultPalette' => null,
|
|
'duotone' => null,
|
|
'gradients' => null,
|
|
'link' => null,
|
|
'palette' => null,
|
|
'text' => null,
|
|
),
|
|
'custom' => null,
|
|
'layout' => array(
|
|
'contentSize' => null,
|
|
'wideSize' => null,
|
|
),
|
|
'spacing' => array(
|
|
'blockGap' => null,
|
|
'margin' => null,
|
|
'padding' => null,
|
|
'units' => null,
|
|
),
|
|
'typography' => array(
|
|
'customFontSize' => null,
|
|
'dropCap' => null,
|
|
'fontFamilies' => null,
|
|
'fontSizes' => null,
|
|
'fontStyle' => null,
|
|
'fontWeight' => null,
|
|
'letterSpacing' => null,
|
|
'lineHeight' => null,
|
|
'textDecoration' => null,
|
|
'textTransform' => null,
|
|
),
|
|
);
|
|
|
|
/**
|
|
* The valid properties under the styles key.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Renamed from ALLOWED_SETTINGS, gained new properties.
|
|
* @var array
|
|
*/
|
|
const VALID_STYLES = array(
|
|
'border' => array(
|
|
'color' => null,
|
|
'radius' => null,
|
|
'style' => null,
|
|
'width' => null,
|
|
),
|
|
'color' => array(
|
|
'background' => null,
|
|
'gradient' => null,
|
|
'text' => null,
|
|
),
|
|
'filter' => array(
|
|
'duotone' => null,
|
|
),
|
|
'spacing' => array(
|
|
'margin' => null,
|
|
'padding' => null,
|
|
'blockGap' => null,
|
|
),
|
|
'typography' => array(
|
|
'fontFamily' => null,
|
|
'fontSize' => null,
|
|
'fontStyle' => null,
|
|
'fontWeight' => null,
|
|
'letterSpacing' => null,
|
|
'lineHeight' => null,
|
|
'textDecoration' => null,
|
|
'textTransform' => null,
|
|
),
|
|
);
|
|
|
|
/**
|
|
* The valid elements that can be found under styles.
|
|
*
|
|
* @since 5.8.0
|
|
* @var string[]
|
|
*/
|
|
const ELEMENTS = array(
|
|
'link' => 'a',
|
|
'h1' => 'h1',
|
|
'h2' => 'h2',
|
|
'h3' => 'h3',
|
|
'h4' => 'h4',
|
|
'h5' => 'h5',
|
|
'h6' => 'h6',
|
|
);
|
|
|
|
/**
|
|
* The latest version of the schema in use.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Changed value.
|
|
* @var int
|
|
*/
|
|
const LATEST_SCHEMA = 2;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $theme_json A structure that follows the theme.json schema.
|
|
* @param string $origin Optional. What source of data this object represents.
|
|
* One of 'default', 'theme', or 'custom'. Default 'theme'.
|
|
*/
|
|
public function __construct( $theme_json = array(), $origin = 'theme' ) {
|
|
if ( ! in_array( $origin, self::VALID_ORIGINS, true ) ) {
|
|
$origin = 'theme';
|
|
}
|
|
|
|
$this->theme_json = WP_Theme_JSON_Schema::migrate( $theme_json );
|
|
$valid_block_names = array_keys( self::get_blocks_metadata() );
|
|
$valid_element_names = array_keys( self::ELEMENTS );
|
|
$theme_json = self::sanitize( $this->theme_json, $valid_block_names, $valid_element_names );
|
|
$this->theme_json = self::maybe_opt_in_into_settings( $theme_json );
|
|
|
|
// Internally, presets are keyed by origin.
|
|
$nodes = self::get_setting_nodes( $this->theme_json );
|
|
foreach ( $nodes as $node ) {
|
|
foreach ( self::PRESETS_METADATA as $preset_metadata ) {
|
|
$path = array_merge( $node['path'], $preset_metadata['path'] );
|
|
$preset = _wp_array_get( $this->theme_json, $path, null );
|
|
if ( null !== $preset ) {
|
|
// If the preset is not already keyed by origin.
|
|
if ( isset( $preset[0] ) || empty( $preset ) ) {
|
|
_wp_array_set( $this->theme_json, $path, array( $origin => $preset ) );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enables some opt-in settings if theme declared support.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $theme_json A theme.json structure to modify.
|
|
* @return array The modified theme.json structure.
|
|
*/
|
|
private static function maybe_opt_in_into_settings( $theme_json ) {
|
|
$new_theme_json = $theme_json;
|
|
|
|
if ( isset( $new_theme_json['settings']['appearanceTools'] ) ) {
|
|
self::do_opt_in_into_settings( $new_theme_json['settings'] );
|
|
}
|
|
|
|
if ( isset( $new_theme_json['settings']['blocks'] ) && is_array( $new_theme_json['settings']['blocks'] ) ) {
|
|
foreach ( $new_theme_json['settings']['blocks'] as &$block ) {
|
|
if ( isset( $block['appearanceTools'] ) ) {
|
|
self::do_opt_in_into_settings( $block );
|
|
}
|
|
}
|
|
}
|
|
|
|
return $new_theme_json;
|
|
}
|
|
|
|
/**
|
|
* Enables some settings.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $context The context to which the settings belong.
|
|
*/
|
|
private static function do_opt_in_into_settings( &$context ) {
|
|
$to_opt_in = array(
|
|
array( 'border', 'color' ),
|
|
array( 'border', 'radius' ),
|
|
array( 'border', 'style' ),
|
|
array( 'border', 'width' ),
|
|
array( 'color', 'link' ),
|
|
array( 'spacing', 'blockGap' ),
|
|
array( 'spacing', 'margin' ),
|
|
array( 'spacing', 'padding' ),
|
|
array( 'typography', 'lineHeight' ),
|
|
);
|
|
|
|
foreach ( $to_opt_in as $path ) {
|
|
if ( null === _wp_array_get( $context, $path, null ) ) {
|
|
_wp_array_set( $context, $path, true );
|
|
}
|
|
}
|
|
|
|
unset( $context['appearanceTools'] );
|
|
}
|
|
|
|
/**
|
|
* Sanitizes the input according to the schemas.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Has new parameters.
|
|
*
|
|
* @param array $input Structure to sanitize.
|
|
* @param array $valid_block_names List of valid block names.
|
|
* @param array $valid_element_names List of valid element names.
|
|
* @return array The sanitized output.
|
|
*/
|
|
private static function sanitize( $input, $valid_block_names, $valid_element_names ) {
|
|
$output = array();
|
|
|
|
if ( ! is_array( $input ) ) {
|
|
return $output;
|
|
}
|
|
|
|
$output = array_intersect_key( $input, array_flip( self::VALID_TOP_LEVEL_KEYS ) );
|
|
|
|
// Build the schema based on valid block & element names.
|
|
$schema = array();
|
|
$schema_styles_elements = array();
|
|
foreach ( $valid_element_names as $element ) {
|
|
$schema_styles_elements[ $element ] = self::VALID_STYLES;
|
|
}
|
|
$schema_styles_blocks = array();
|
|
$schema_settings_blocks = array();
|
|
foreach ( $valid_block_names as $block ) {
|
|
$schema_settings_blocks[ $block ] = self::VALID_SETTINGS;
|
|
$schema_styles_blocks[ $block ] = self::VALID_STYLES;
|
|
$schema_styles_blocks[ $block ]['elements'] = $schema_styles_elements;
|
|
}
|
|
$schema['styles'] = self::VALID_STYLES;
|
|
$schema['styles']['blocks'] = $schema_styles_blocks;
|
|
$schema['styles']['elements'] = $schema_styles_elements;
|
|
$schema['settings'] = self::VALID_SETTINGS;
|
|
$schema['settings']['blocks'] = $schema_settings_blocks;
|
|
|
|
// Remove anything that's not present in the schema.
|
|
foreach ( array( 'styles', 'settings' ) as $subtree ) {
|
|
if ( ! isset( $input[ $subtree ] ) ) {
|
|
continue;
|
|
}
|
|
|
|
if ( ! is_array( $input[ $subtree ] ) ) {
|
|
unset( $output[ $subtree ] );
|
|
continue;
|
|
}
|
|
|
|
$result = self::remove_keys_not_in_schema( $input[ $subtree ], $schema[ $subtree ] );
|
|
|
|
if ( empty( $result ) ) {
|
|
unset( $output[ $subtree ] );
|
|
} else {
|
|
$output[ $subtree ] = $result;
|
|
}
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Returns the metadata for each block.
|
|
*
|
|
* Example:
|
|
*
|
|
* {
|
|
* 'core/paragraph': {
|
|
* 'selector': 'p',
|
|
* 'elements': {
|
|
* 'link' => 'link selector',
|
|
* 'etc' => 'element selector'
|
|
* }
|
|
* },
|
|
* 'core/heading': {
|
|
* 'selector': 'h1',
|
|
* 'elements': {}
|
|
* },
|
|
* 'core/image': {
|
|
* 'selector': '.wp-block-image',
|
|
* 'duotone': 'img',
|
|
* 'elements': {}
|
|
* }
|
|
* }
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Added duotone key with CSS selector.
|
|
*
|
|
* @return array Block metadata.
|
|
*/
|
|
private static function get_blocks_metadata() {
|
|
if ( null !== self::$blocks_metadata ) {
|
|
return self::$blocks_metadata;
|
|
}
|
|
|
|
self::$blocks_metadata = array();
|
|
|
|
$registry = WP_Block_Type_Registry::get_instance();
|
|
$blocks = $registry->get_all_registered();
|
|
foreach ( $blocks as $block_name => $block_type ) {
|
|
if (
|
|
isset( $block_type->supports['__experimentalSelector'] ) &&
|
|
is_string( $block_type->supports['__experimentalSelector'] )
|
|
) {
|
|
self::$blocks_metadata[ $block_name ]['selector'] = $block_type->supports['__experimentalSelector'];
|
|
} else {
|
|
self::$blocks_metadata[ $block_name ]['selector'] = '.wp-block-' . str_replace( '/', '-', str_replace( 'core/', '', $block_name ) );
|
|
}
|
|
|
|
if (
|
|
isset( $block_type->supports['color']['__experimentalDuotone'] ) &&
|
|
is_string( $block_type->supports['color']['__experimentalDuotone'] )
|
|
) {
|
|
self::$blocks_metadata[ $block_name ]['duotone'] = $block_type->supports['color']['__experimentalDuotone'];
|
|
}
|
|
|
|
// Assign defaults, then overwrite those that the block sets by itself.
|
|
// If the block selector is compounded, will append the element to each
|
|
// individual block selector.
|
|
$block_selectors = explode( ',', self::$blocks_metadata[ $block_name ]['selector'] );
|
|
foreach ( self::ELEMENTS as $el_name => $el_selector ) {
|
|
$element_selector = array();
|
|
foreach ( $block_selectors as $selector ) {
|
|
$element_selector[] = $selector . ' ' . $el_selector;
|
|
}
|
|
self::$blocks_metadata[ $block_name ]['elements'][ $el_name ] = implode( ',', $element_selector );
|
|
}
|
|
}
|
|
|
|
return self::$blocks_metadata;
|
|
}
|
|
|
|
/**
|
|
* Given a tree, removes the keys that are not present in the schema.
|
|
*
|
|
* It is recursive and modifies the input in-place.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $tree Input to process.
|
|
* @param array $schema Schema to adhere to.
|
|
* @return array Returns the modified $tree.
|
|
*/
|
|
private static function remove_keys_not_in_schema( $tree, $schema ) {
|
|
$tree = array_intersect_key( $tree, $schema );
|
|
|
|
foreach ( $schema as $key => $data ) {
|
|
if ( ! isset( $tree[ $key ] ) ) {
|
|
continue;
|
|
}
|
|
|
|
if ( is_array( $schema[ $key ] ) && is_array( $tree[ $key ] ) ) {
|
|
$tree[ $key ] = self::remove_keys_not_in_schema( $tree[ $key ], $schema[ $key ] );
|
|
|
|
if ( empty( $tree[ $key ] ) ) {
|
|
unset( $tree[ $key ] );
|
|
}
|
|
} elseif ( is_array( $schema[ $key ] ) && ! is_array( $tree[ $key ] ) ) {
|
|
unset( $tree[ $key ] );
|
|
}
|
|
}
|
|
|
|
return $tree;
|
|
}
|
|
|
|
/**
|
|
* Returns the existing settings for each block.
|
|
*
|
|
* Example:
|
|
*
|
|
* {
|
|
* 'root': {
|
|
* 'color': {
|
|
* 'custom': true
|
|
* }
|
|
* },
|
|
* 'core/paragraph': {
|
|
* 'spacing': {
|
|
* 'customPadding': true
|
|
* }
|
|
* }
|
|
* }
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @return array Settings per block.
|
|
*/
|
|
public function get_settings() {
|
|
if ( ! isset( $this->theme_json['settings'] ) ) {
|
|
return array();
|
|
} else {
|
|
return $this->theme_json['settings'];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the stylesheet that results of processing
|
|
* the theme.json structure this object represents.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Changed the arguments passed to the function.
|
|
*
|
|
* @param array $types Types of styles to load. Will load all by default. It accepts:
|
|
* 'variables': only the CSS Custom Properties for presets & custom ones.
|
|
* 'styles': only the styles section in theme.json.
|
|
* 'presets': only the classes for the presets.
|
|
* @param array $origins A list of origins to include. By default it includes self::VALID_ORIGINS.
|
|
* @return string Stylesheet.
|
|
*/
|
|
public function get_stylesheet( $types = array( 'variables', 'styles', 'presets' ), $origins = self::VALID_ORIGINS ) {
|
|
if ( is_string( $types ) ) {
|
|
// Dispatch error and map old arguments to new ones.
|
|
_deprecated_argument( __FUNCTION__, '5.9' );
|
|
if ( 'block_styles' === $types ) {
|
|
$types = array( 'styles', 'presets' );
|
|
} elseif ( 'css_variables' === $types ) {
|
|
$types = array( 'variables' );
|
|
} else {
|
|
$types = array( 'variables', 'styles', 'presets' );
|
|
}
|
|
}
|
|
|
|
$blocks_metadata = self::get_blocks_metadata();
|
|
$style_nodes = self::get_style_nodes( $this->theme_json, $blocks_metadata );
|
|
$setting_nodes = self::get_setting_nodes( $this->theme_json, $blocks_metadata );
|
|
|
|
$stylesheet = '';
|
|
|
|
if ( in_array( 'variables', $types, true ) ) {
|
|
$stylesheet .= $this->get_css_variables( $setting_nodes, $origins );
|
|
}
|
|
|
|
if ( in_array( 'styles', $types, true ) ) {
|
|
$stylesheet .= $this->get_block_classes( $style_nodes );
|
|
}
|
|
|
|
if ( in_array( 'presets', $types, true ) ) {
|
|
$stylesheet .= $this->get_preset_classes( $setting_nodes, $origins );
|
|
}
|
|
|
|
return $stylesheet;
|
|
}
|
|
|
|
/**
|
|
* Returns the page templates of the current theme.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_custom_templates() {
|
|
$custom_templates = array();
|
|
if ( ! isset( $this->theme_json['customTemplates'] ) || ! is_array( $this->theme_json['customTemplates'] ) ) {
|
|
return $custom_templates;
|
|
}
|
|
|
|
foreach ( $this->theme_json['customTemplates'] as $item ) {
|
|
if ( isset( $item['name'] ) ) {
|
|
$custom_templates[ $item['name'] ] = array(
|
|
'title' => isset( $item['title'] ) ? $item['title'] : '',
|
|
'postTypes' => isset( $item['postTypes'] ) ? $item['postTypes'] : array( 'page' ),
|
|
);
|
|
}
|
|
}
|
|
return $custom_templates;
|
|
}
|
|
|
|
/**
|
|
* Returns the template part data of current theme.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function get_template_parts() {
|
|
$template_parts = array();
|
|
if ( ! isset( $this->theme_json['templateParts'] ) || ! is_array( $this->theme_json['templateParts'] ) ) {
|
|
return $template_parts;
|
|
}
|
|
|
|
foreach ( $this->theme_json['templateParts'] as $item ) {
|
|
if ( isset( $item['name'] ) ) {
|
|
$template_parts[ $item['name'] ] = array(
|
|
'title' => isset( $item['title'] ) ? $item['title'] : '',
|
|
'area' => isset( $item['area'] ) ? $item['area'] : '',
|
|
);
|
|
}
|
|
}
|
|
return $template_parts;
|
|
}
|
|
|
|
/**
|
|
* Converts each style section into a list of rulesets
|
|
* containing the block styles to be appended to the stylesheet.
|
|
*
|
|
* See glossary at https://developer.mozilla.org/en-US/docs/Web/CSS/Syntax
|
|
*
|
|
* For each section this creates a new ruleset such as:
|
|
*
|
|
* block-selector {
|
|
* style-property-one: value;
|
|
* }
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Renamed to get_block_classes and no longer returns preset classes.
|
|
*
|
|
* @param array $style_nodes Nodes with styles.
|
|
* @return string The new stylesheet.
|
|
*/
|
|
private function get_block_classes( $style_nodes ) {
|
|
$block_rules = '';
|
|
|
|
foreach ( $style_nodes as $metadata ) {
|
|
if ( null === $metadata['selector'] ) {
|
|
continue;
|
|
}
|
|
|
|
$node = _wp_array_get( $this->theme_json, $metadata['path'], array() );
|
|
$selector = $metadata['selector'];
|
|
$settings = _wp_array_get( $this->theme_json, array( 'settings' ) );
|
|
$declarations = self::compute_style_properties( $node, $settings );
|
|
|
|
// 1. Separate the ones who use the general selector
|
|
// and the ones who use the duotone selector.
|
|
$declarations_duotone = array();
|
|
foreach ( $declarations as $index => $declaration ) {
|
|
if ( 'filter' === $declaration['name'] ) {
|
|
unset( $declarations[ $index ] );
|
|
$declarations_duotone[] = $declaration;
|
|
}
|
|
}
|
|
|
|
// 2. Generate the rules that use the general selector.
|
|
$block_rules .= self::to_ruleset( $selector, $declarations );
|
|
|
|
// 3. Generate the rules that use the duotone selector.
|
|
if ( isset( $metadata['duotone'] ) && ! empty( $declarations_duotone ) ) {
|
|
$selector_duotone = self::scope_selector( $metadata['selector'], $metadata['duotone'] );
|
|
$block_rules .= self::to_ruleset( $selector_duotone, $declarations_duotone );
|
|
}
|
|
|
|
if ( self::ROOT_BLOCK_SELECTOR === $selector ) {
|
|
$block_rules .= 'body { margin: 0; }';
|
|
$block_rules .= '.wp-site-blocks > .alignleft { float: left; margin-right: 2em; }';
|
|
$block_rules .= '.wp-site-blocks > .alignright { float: right; margin-left: 2em; }';
|
|
$block_rules .= '.wp-site-blocks > .aligncenter { justify-content: center; margin-left: auto; margin-right: auto; }';
|
|
|
|
$has_block_gap_support = _wp_array_get( $this->theme_json, array( 'settings', 'spacing', 'blockGap' ) ) !== null;
|
|
if ( $has_block_gap_support ) {
|
|
$block_rules .= '.wp-site-blocks > * { margin-top: 0; margin-bottom: 0; }';
|
|
$block_rules .= '.wp-site-blocks > * + * { margin-top: var( --wp--style--block-gap ); }';
|
|
}
|
|
}
|
|
}
|
|
|
|
return $block_rules;
|
|
}
|
|
|
|
/**
|
|
* Creates new rulesets as classes for each preset value such as:
|
|
*
|
|
* .has-value-color {
|
|
* color: value;
|
|
* }
|
|
*
|
|
* .has-value-background-color {
|
|
* background-color: value;
|
|
* }
|
|
*
|
|
* .has-value-font-size {
|
|
* font-size: value;
|
|
* }
|
|
*
|
|
* .has-value-gradient-background {
|
|
* background: value;
|
|
* }
|
|
*
|
|
* p.has-value-gradient-background {
|
|
* background: value;
|
|
* }
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $setting_nodes Nodes with settings.
|
|
* @param array $origins List of origins to process presets from.
|
|
* @return string The new stylesheet.
|
|
*/
|
|
private function get_preset_classes( $setting_nodes, $origins ) {
|
|
$preset_rules = '';
|
|
|
|
foreach ( $setting_nodes as $metadata ) {
|
|
if ( null === $metadata['selector'] ) {
|
|
continue;
|
|
}
|
|
|
|
$selector = $metadata['selector'];
|
|
$node = _wp_array_get( $this->theme_json, $metadata['path'], array() );
|
|
$preset_rules .= self::compute_preset_classes( $node, $selector, $origins );
|
|
}
|
|
|
|
return $preset_rules;
|
|
}
|
|
|
|
/**
|
|
* Converts each styles section into a list of rulesets
|
|
* to be appended to the stylesheet.
|
|
* These rulesets contain all the css variables (custom variables and preset variables).
|
|
*
|
|
* See glossary at https://developer.mozilla.org/en-US/docs/Web/CSS/Syntax
|
|
*
|
|
* For each section this creates a new ruleset such as:
|
|
*
|
|
* block-selector {
|
|
* --wp--preset--category--slug: value;
|
|
* --wp--custom--variable: value;
|
|
* }
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Added origins parameter.
|
|
*
|
|
* @param array $nodes Nodes with settings.
|
|
* @param array $origins List of origins to process.
|
|
* @return string The new stylesheet.
|
|
*/
|
|
private function get_css_variables( $nodes, $origins ) {
|
|
$stylesheet = '';
|
|
foreach ( $nodes as $metadata ) {
|
|
if ( null === $metadata['selector'] ) {
|
|
continue;
|
|
}
|
|
|
|
$selector = $metadata['selector'];
|
|
|
|
$node = _wp_array_get( $this->theme_json, $metadata['path'], array() );
|
|
$declarations = array_merge( self::compute_preset_vars( $node, $origins ), self::compute_theme_vars( $node ) );
|
|
|
|
$stylesheet .= self::to_ruleset( $selector, $declarations );
|
|
}
|
|
|
|
return $stylesheet;
|
|
}
|
|
|
|
/**
|
|
* Given a selector and a declaration list,
|
|
* creates the corresponding ruleset.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $selector CSS selector.
|
|
* @param array $declarations List of declarations.
|
|
* @return string CSS ruleset.
|
|
*/
|
|
private static function to_ruleset( $selector, $declarations ) {
|
|
if ( empty( $declarations ) ) {
|
|
return '';
|
|
}
|
|
|
|
$declaration_block = array_reduce(
|
|
$declarations,
|
|
static function ( $carry, $element ) {
|
|
return $carry .= $element['name'] . ': ' . $element['value'] . ';'; },
|
|
''
|
|
);
|
|
|
|
return $selector . '{' . $declaration_block . '}';
|
|
}
|
|
|
|
/**
|
|
* Function that appends a sub-selector to a existing one.
|
|
*
|
|
* Given the compounded $selector "h1, h2, h3"
|
|
* and the $to_append selector ".some-class" the result will be
|
|
* "h1.some-class, h2.some-class, h3.some-class".
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $selector Original selector.
|
|
* @param string $to_append Selector to append.
|
|
* @return string
|
|
*/
|
|
private static function append_to_selector( $selector, $to_append ) {
|
|
$new_selectors = array();
|
|
$selectors = explode( ',', $selector );
|
|
foreach ( $selectors as $sel ) {
|
|
$new_selectors[] = $sel . $to_append;
|
|
}
|
|
|
|
return implode( ',', $new_selectors );
|
|
}
|
|
|
|
/**
|
|
* Given a settings array, it returns the generated rulesets
|
|
* for the preset classes.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Added origins parameter.
|
|
*
|
|
* @param array $settings Settings to process.
|
|
* @param string $selector Selector wrapping the classes.
|
|
* @param array $origins List of origins to process.
|
|
* @return string The result of processing the presets.
|
|
*/
|
|
private static function compute_preset_classes( $settings, $selector, $origins ) {
|
|
if ( self::ROOT_BLOCK_SELECTOR === $selector ) {
|
|
// Classes at the global level do not need any CSS prefixed,
|
|
// and we don't want to increase its specificity.
|
|
$selector = '';
|
|
}
|
|
|
|
$stylesheet = '';
|
|
foreach ( self::PRESETS_METADATA as $preset_metadata ) {
|
|
$slugs = self::get_settings_slugs( $settings, $preset_metadata, $origins );
|
|
foreach ( $preset_metadata['classes'] as $class => $property ) {
|
|
foreach ( $slugs as $slug ) {
|
|
$css_var = self::replace_slug_in_string( $preset_metadata['css_vars'], $slug );
|
|
$class_name = self::replace_slug_in_string( $class, $slug );
|
|
$stylesheet .= self::to_ruleset(
|
|
self::append_to_selector( $selector, $class_name ),
|
|
array(
|
|
array(
|
|
'name' => $property,
|
|
'value' => 'var(' . $css_var . ') !important',
|
|
),
|
|
)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $stylesheet;
|
|
}
|
|
|
|
/**
|
|
* Function that scopes a selector with another one. This works a bit like
|
|
* SCSS nesting except the `&` operator isn't supported.
|
|
*
|
|
* <code>
|
|
* $scope = '.a, .b .c';
|
|
* $selector = '> .x, .y';
|
|
* $merged = scope_selector( $scope, $selector );
|
|
* // $merged is '.a > .x, .a .y, .b .c > .x, .b .c .y'
|
|
* </code>
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param string $scope Selector to scope to.
|
|
* @param string $selector Original selector.
|
|
*
|
|
* @return string Scoped selector.
|
|
*/
|
|
private static function scope_selector( $scope, $selector ) {
|
|
$scopes = explode( ',', $scope );
|
|
$selectors = explode( ',', $selector );
|
|
|
|
$selectors_scoped = array();
|
|
foreach ( $scopes as $outer ) {
|
|
foreach ( $selectors as $inner ) {
|
|
$selectors_scoped[] = trim( $outer ) . ' ' . trim( $inner );
|
|
}
|
|
}
|
|
|
|
return implode( ', ', $selectors_scoped );
|
|
}
|
|
|
|
/**
|
|
* Gets preset values keyed by slugs based on settings and metadata.
|
|
*
|
|
* <code>
|
|
* $settings = array(
|
|
* 'typography' => array(
|
|
* 'fontFamilies' => array(
|
|
* array(
|
|
* 'slug' => 'sansSerif',
|
|
* 'fontFamily' => '"Helvetica Neue", sans-serif',
|
|
* ),
|
|
* array(
|
|
* 'slug' => 'serif',
|
|
* 'colors' => 'Georgia, serif',
|
|
* )
|
|
* ),
|
|
* ),
|
|
* );
|
|
* $meta = array(
|
|
* 'path' => array( 'typography', 'fontFamilies' ),
|
|
* 'value_key' => 'fontFamily',
|
|
* );
|
|
* $values_by_slug = get_settings_values_by_slug();
|
|
* // $values_by_slug === array(
|
|
* // 'sans-serif' => '"Helvetica Neue", sans-serif',
|
|
* // 'serif' => 'Georgia, serif',
|
|
* // );
|
|
* </code>
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $settings Settings to process.
|
|
* @param array $preset_metadata One of the PRESETS_METADATA values.
|
|
* @param array $origins List of origins to process.
|
|
* @return array Array of presets where each key is a slug and each value is the preset value.
|
|
*/
|
|
private static function get_settings_values_by_slug( $settings, $preset_metadata, $origins ) {
|
|
$preset_per_origin = _wp_array_get( $settings, $preset_metadata['path'], array() );
|
|
|
|
$result = array();
|
|
foreach ( $origins as $origin ) {
|
|
if ( ! isset( $preset_per_origin[ $origin ] ) ) {
|
|
continue;
|
|
}
|
|
foreach ( $preset_per_origin[ $origin ] as $preset ) {
|
|
$slug = _wp_to_kebab_case( $preset['slug'] );
|
|
|
|
$value = '';
|
|
if ( isset( $preset_metadata['value_key'] ) ) {
|
|
$value_key = $preset_metadata['value_key'];
|
|
$value = $preset[ $value_key ];
|
|
} elseif (
|
|
isset( $preset_metadata['value_func'] ) &&
|
|
is_callable( $preset_metadata['value_func'] )
|
|
) {
|
|
$value_func = $preset_metadata['value_func'];
|
|
$value = call_user_func( $value_func, $preset );
|
|
} else {
|
|
// If we don't have a value, then don't add it to the result.
|
|
continue;
|
|
}
|
|
|
|
$result[ $slug ] = $value;
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Similar to get_settings_values_by_slug, but doesn't compute the value.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $settings Settings to process.
|
|
* @param array $preset_metadata One of the PRESETS_METADATA values.
|
|
* @param array $origins List of origins to process.
|
|
* @return array Array of presets where the key and value are both the slug.
|
|
*/
|
|
private static function get_settings_slugs( $settings, $preset_metadata, $origins = self::VALID_ORIGINS ) {
|
|
$preset_per_origin = _wp_array_get( $settings, $preset_metadata['path'], array() );
|
|
|
|
$result = array();
|
|
foreach ( $origins as $origin ) {
|
|
if ( ! isset( $preset_per_origin[ $origin ] ) ) {
|
|
continue;
|
|
}
|
|
foreach ( $preset_per_origin[ $origin ] as $preset ) {
|
|
$slug = _wp_to_kebab_case( $preset['slug'] );
|
|
|
|
// Use the array as a set so we don't get duplicates.
|
|
$result[ $slug ] = $slug;
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Transform a slug into a CSS Custom Property.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param string $input String to replace.
|
|
* @param string $slug The slug value to use to generate the custom property.
|
|
* @return string The CSS Custom Property. Something along the lines of --wp--preset--color--black.
|
|
*/
|
|
private static function replace_slug_in_string( $input, $slug ) {
|
|
return strtr( $input, array( '$slug' => $slug ) );
|
|
}
|
|
|
|
/**
|
|
* Given the block settings, it extracts the CSS Custom Properties
|
|
* for the presets and adds them to the $declarations array
|
|
* following the format:
|
|
*
|
|
* array(
|
|
* 'name' => 'property_name',
|
|
* 'value' => 'property_value,
|
|
* )
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $settings Settings to process.
|
|
* @param array $origins List of origins to process.
|
|
* @return array Returns the modified $declarations.
|
|
*/
|
|
private static function compute_preset_vars( $settings, $origins ) {
|
|
$declarations = array();
|
|
foreach ( self::PRESETS_METADATA as $preset_metadata ) {
|
|
$values_by_slug = self::get_settings_values_by_slug( $settings, $preset_metadata, $origins );
|
|
foreach ( $values_by_slug as $slug => $value ) {
|
|
$declarations[] = array(
|
|
'name' => self::replace_slug_in_string( $preset_metadata['css_vars'], $slug ),
|
|
'value' => $value,
|
|
);
|
|
}
|
|
}
|
|
|
|
return $declarations;
|
|
}
|
|
|
|
/**
|
|
* Given an array of settings, it extracts the CSS Custom Properties
|
|
* for the custom values and adds them to the $declarations
|
|
* array following the format:
|
|
*
|
|
* array(
|
|
* 'name' => 'property_name',
|
|
* 'value' => 'property_value,
|
|
* )
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $settings Settings to process.
|
|
* @return array Returns the modified $declarations.
|
|
*/
|
|
private static function compute_theme_vars( $settings ) {
|
|
$declarations = array();
|
|
$custom_values = _wp_array_get( $settings, array( 'custom' ), array() );
|
|
$css_vars = self::flatten_tree( $custom_values );
|
|
foreach ( $css_vars as $key => $value ) {
|
|
$declarations[] = array(
|
|
'name' => '--wp--custom--' . $key,
|
|
'value' => $value,
|
|
);
|
|
}
|
|
|
|
return $declarations;
|
|
}
|
|
|
|
/**
|
|
* Given a tree, it creates a flattened one
|
|
* by merging the keys and binding the leaf values
|
|
* to the new keys.
|
|
*
|
|
* It also transforms camelCase names into kebab-case
|
|
* and substitutes '/' by '-'.
|
|
*
|
|
* This is thought to be useful to generate
|
|
* CSS Custom Properties from a tree,
|
|
* although there's nothing in the implementation
|
|
* of this function that requires that format.
|
|
*
|
|
* For example, assuming the given prefix is '--wp'
|
|
* and the token is '--', for this input tree:
|
|
*
|
|
* {
|
|
* 'some/property': 'value',
|
|
* 'nestedProperty': {
|
|
* 'sub-property': 'value'
|
|
* }
|
|
* }
|
|
*
|
|
* it'll return this output:
|
|
*
|
|
* {
|
|
* '--wp--some-property': 'value',
|
|
* '--wp--nested-property--sub-property': 'value'
|
|
* }
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $tree Input tree to process.
|
|
* @param string $prefix Optional. Prefix to prepend to each variable. Default empty string.
|
|
* @param string $token Optional. Token to use between levels. Default '--'.
|
|
* @return array The flattened tree.
|
|
*/
|
|
private static function flatten_tree( $tree, $prefix = '', $token = '--' ) {
|
|
$result = array();
|
|
foreach ( $tree as $property => $value ) {
|
|
$new_key = $prefix . str_replace(
|
|
'/',
|
|
'-',
|
|
strtolower( preg_replace( '/(?<!^)[A-Z]/', '-$0', $property ) ) // CamelCase to kebab-case.
|
|
);
|
|
|
|
if ( is_array( $value ) ) {
|
|
$new_prefix = $new_key . $token;
|
|
$result = array_merge(
|
|
$result,
|
|
self::flatten_tree( $value, $new_prefix, $token )
|
|
);
|
|
} else {
|
|
$result[ $new_key ] = $value;
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Given a styles array, it extracts the style properties
|
|
* and adds them to the $declarations array following the format:
|
|
*
|
|
* array(
|
|
* 'name' => 'property_name',
|
|
* 'value' => 'property_value,
|
|
* )
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Added theme setting and properties parameters.
|
|
*
|
|
* @param array $styles Styles to process.
|
|
* @param array $settings Theme settings.
|
|
* @param array $properties Properties metadata.
|
|
* @return array Returns the modified $declarations.
|
|
*/
|
|
private static function compute_style_properties( $styles, $settings = array(), $properties = self::PROPERTIES_METADATA ) {
|
|
$declarations = array();
|
|
if ( empty( $styles ) ) {
|
|
return $declarations;
|
|
}
|
|
|
|
foreach ( $properties as $css_property => $value_path ) {
|
|
$value = self::get_property_value( $styles, $value_path );
|
|
|
|
// Look up protected properties, keyed by value path.
|
|
// Skip protected properties that are explicitly set to `null`.
|
|
if ( is_array( $value_path ) ) {
|
|
$path_string = implode( '.', $value_path );
|
|
if (
|
|
array_key_exists( $path_string, self::PROTECTED_PROPERTIES ) &&
|
|
_wp_array_get( $settings, self::PROTECTED_PROPERTIES[ $path_string ], null ) === null
|
|
) {
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// Skip if empty and not "0" or value represents array of longhand values.
|
|
$has_missing_value = empty( $value ) && ! is_numeric( $value );
|
|
if ( $has_missing_value || is_array( $value ) ) {
|
|
continue;
|
|
}
|
|
|
|
$declarations[] = array(
|
|
'name' => $css_property,
|
|
'value' => $value,
|
|
);
|
|
}
|
|
|
|
return $declarations;
|
|
}
|
|
|
|
/**
|
|
* Returns the style property for the given path.
|
|
*
|
|
* It also converts CSS Custom Property stored as
|
|
* "var:preset|color|secondary" to the form
|
|
* "--wp--preset--color--secondary".
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Consider $value that are arrays as well.
|
|
*
|
|
* @param array $styles Styles subtree.
|
|
* @param array $path Which property to process.
|
|
* @return string Style property value.
|
|
*/
|
|
private static function get_property_value( $styles, $path ) {
|
|
$value = _wp_array_get( $styles, $path, '' );
|
|
|
|
if ( '' === $value || is_array( $value ) ) {
|
|
return $value;
|
|
}
|
|
|
|
$prefix = 'var:';
|
|
$prefix_len = strlen( $prefix );
|
|
$token_in = '|';
|
|
$token_out = '--';
|
|
if ( 0 === strncmp( $value, $prefix, $prefix_len ) ) {
|
|
$unwrapped_name = str_replace(
|
|
$token_in,
|
|
$token_out,
|
|
substr( $value, $prefix_len )
|
|
);
|
|
$value = "var(--wp--$unwrapped_name)";
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Builds metadata for the setting nodes, which returns in the form of:
|
|
*
|
|
* [
|
|
* [
|
|
* 'path' => ['path', 'to', 'some', 'node' ],
|
|
* 'selector' => 'CSS selector for some node'
|
|
* ],
|
|
* [
|
|
* 'path' => [ 'path', 'to', 'other', 'node' ],
|
|
* 'selector' => 'CSS selector for other node'
|
|
* ],
|
|
* ]
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $theme_json The tree to extract setting nodes from.
|
|
* @param array $selectors List of selectors per block.
|
|
* @return array
|
|
*/
|
|
private static function get_setting_nodes( $theme_json, $selectors = array() ) {
|
|
$nodes = array();
|
|
if ( ! isset( $theme_json['settings'] ) ) {
|
|
return $nodes;
|
|
}
|
|
|
|
// Top-level.
|
|
$nodes[] = array(
|
|
'path' => array( 'settings' ),
|
|
'selector' => self::ROOT_BLOCK_SELECTOR,
|
|
);
|
|
|
|
// Calculate paths for blocks.
|
|
if ( ! isset( $theme_json['settings']['blocks'] ) ) {
|
|
return $nodes;
|
|
}
|
|
|
|
foreach ( $theme_json['settings']['blocks'] as $name => $node ) {
|
|
$selector = null;
|
|
if ( isset( $selectors[ $name ]['selector'] ) ) {
|
|
$selector = $selectors[ $name ]['selector'];
|
|
}
|
|
|
|
$nodes[] = array(
|
|
'path' => array( 'settings', 'blocks', $name ),
|
|
'selector' => $selector,
|
|
);
|
|
}
|
|
|
|
return $nodes;
|
|
}
|
|
|
|
/**
|
|
* Builds metadata for the style nodes, which returns in the form of:
|
|
*
|
|
* [
|
|
* [
|
|
* 'path' => [ 'path', 'to', 'some', 'node' ],
|
|
* 'selector' => 'CSS selector for some node',
|
|
* 'duotone' => 'CSS selector for duotone for some node'
|
|
* ],
|
|
* [
|
|
* 'path' => ['path', 'to', 'other', 'node' ],
|
|
* 'selector' => 'CSS selector for other node',
|
|
* 'duotone' => null
|
|
* ],
|
|
* ]
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $theme_json The tree to extract style nodes from.
|
|
* @param array $selectors List of selectors per block.
|
|
* @return array
|
|
*/
|
|
private static function get_style_nodes( $theme_json, $selectors = array() ) {
|
|
$nodes = array();
|
|
if ( ! isset( $theme_json['styles'] ) ) {
|
|
return $nodes;
|
|
}
|
|
|
|
// Top-level.
|
|
$nodes[] = array(
|
|
'path' => array( 'styles' ),
|
|
'selector' => self::ROOT_BLOCK_SELECTOR,
|
|
);
|
|
|
|
if ( isset( $theme_json['styles']['elements'] ) ) {
|
|
foreach ( $theme_json['styles']['elements'] as $element => $node ) {
|
|
$nodes[] = array(
|
|
'path' => array( 'styles', 'elements', $element ),
|
|
'selector' => self::ELEMENTS[ $element ],
|
|
);
|
|
}
|
|
}
|
|
|
|
// Blocks.
|
|
if ( ! isset( $theme_json['styles']['blocks'] ) ) {
|
|
return $nodes;
|
|
}
|
|
|
|
foreach ( $theme_json['styles']['blocks'] as $name => $node ) {
|
|
$selector = null;
|
|
if ( isset( $selectors[ $name ]['selector'] ) ) {
|
|
$selector = $selectors[ $name ]['selector'];
|
|
}
|
|
|
|
$duotone_selector = null;
|
|
if ( isset( $selectors[ $name ]['duotone'] ) ) {
|
|
$duotone_selector = $selectors[ $name ]['duotone'];
|
|
}
|
|
|
|
$nodes[] = array(
|
|
'path' => array( 'styles', 'blocks', $name ),
|
|
'selector' => $selector,
|
|
'duotone' => $duotone_selector,
|
|
);
|
|
|
|
if ( isset( $theme_json['styles']['blocks'][ $name ]['elements'] ) ) {
|
|
foreach ( $theme_json['styles']['blocks'][ $name ]['elements'] as $element => $node ) {
|
|
$nodes[] = array(
|
|
'path' => array( 'styles', 'blocks', $name, 'elements', $element ),
|
|
'selector' => $selectors[ $name ]['elements'][ $element ],
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $nodes;
|
|
}
|
|
|
|
/**
|
|
* Merge new incoming data.
|
|
*
|
|
* @since 5.8.0
|
|
* @since 5.9.0 Duotone preset also has origins.
|
|
*
|
|
* @param WP_Theme_JSON $incoming Data to merge.
|
|
*/
|
|
public function merge( $incoming ) {
|
|
$incoming_data = $incoming->get_raw_data();
|
|
$this->theme_json = array_replace_recursive( $this->theme_json, $incoming_data );
|
|
|
|
/*
|
|
* The array_replace_recursive algorithm merges at the leaf level,
|
|
* but we don't want leaf arrays to be merged, so we overwrite it.
|
|
*
|
|
* For leaf values that are sequential arrays it will use the numeric indexes for replacement.
|
|
* We rather replace the existing with the incoming value, if it exists.
|
|
* This is the case of spacing.units.
|
|
*
|
|
* For leaf values that are associative arrays it will merge them as expected.
|
|
* This is also not the behavior we want for the current associative arrays (presets).
|
|
* We rather replace the existing with the incoming value, if it exists.
|
|
* This happens, for example, when we merge data from theme.json upon existing
|
|
* theme supports or when we merge anything coming from the same source twice.
|
|
* This is the case of color.palette, color.gradients, color.duotone,
|
|
* typography.fontSizes, or typography.fontFamilies.
|
|
*
|
|
* Additionally, for some preset types, we also want to make sure the
|
|
* values they introduce don't conflict with default values. We do so
|
|
* by checking the incoming slugs for theme presets and compare them
|
|
* with the equivalent dfefault presets: if a slug is present as a default
|
|
* we remove it from the theme presets.
|
|
*/
|
|
$nodes = self::get_setting_nodes( $incoming_data );
|
|
$slugs_global = self::get_slugs_not_to_override( $this->theme_json );
|
|
foreach ( $nodes as $node ) {
|
|
$slugs_node = self::get_slugs_not_to_override( $this->theme_json, $node['path'] );
|
|
$slugs = array_merge_recursive( $slugs_global, $slugs_node );
|
|
|
|
// Replace the spacing.units.
|
|
$path = array_merge( $node['path'], array( 'spacing', 'units' ) );
|
|
$content = _wp_array_get( $incoming_data, $path, null );
|
|
if ( isset( $content ) ) {
|
|
_wp_array_set( $this->theme_json, $path, $content );
|
|
}
|
|
|
|
// Replace the presets.
|
|
foreach ( self::PRESETS_METADATA as $preset ) {
|
|
foreach ( self::VALID_ORIGINS as $origin ) {
|
|
$path = array_merge( $node['path'], $preset['path'], array( $origin ) );
|
|
$content = _wp_array_get( $incoming_data, $path, null );
|
|
if ( ! isset( $content ) ) {
|
|
continue;
|
|
}
|
|
|
|
if (
|
|
( 'theme' !== $origin ) ||
|
|
( 'theme' === $origin && $preset['override'] )
|
|
) {
|
|
_wp_array_set( $this->theme_json, $path, $content );
|
|
}
|
|
|
|
if ( 'theme' === $origin && ! $preset['override'] ) {
|
|
$content = self::filter_slugs( $content, $preset['path'], $slugs );
|
|
_wp_array_set( $this->theme_json, $path, $content );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the slugs for all the presets that cannot be overriden
|
|
* in the given path. It returns an associative array
|
|
* whose keys are the preset paths and the leafs is the list of slugs.
|
|
*
|
|
* For example:
|
|
*
|
|
* array(
|
|
* 'color' => array(
|
|
* 'palette' => array( 'slug-1', 'slug-2' ),
|
|
* 'gradients' => array( 'slug-3', 'slug-4' ),
|
|
* ),
|
|
* )
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $data A theme.json like structure to inspect.
|
|
* @param array $node_path The path to inspect. It's 'settings' by default.
|
|
*
|
|
* @return array An associative array containing the slugs for the given path.
|
|
*/
|
|
private static function get_slugs_not_to_override( $data, $node_path = array( 'settings' ) ) {
|
|
$slugs = array();
|
|
foreach ( self::PRESETS_METADATA as $metadata ) {
|
|
if ( $metadata['override'] ) {
|
|
continue;
|
|
}
|
|
|
|
$slugs_for_preset = array();
|
|
$path = array_merge( $node_path, $metadata['path'], array( 'default' ) );
|
|
$preset = _wp_array_get( $data, $path, null );
|
|
if ( ! isset( $preset ) ) {
|
|
continue;
|
|
}
|
|
|
|
$slugs_for_preset = array_map(
|
|
function( $value ) {
|
|
return isset( $value['slug'] ) ? $value['slug'] : null;
|
|
},
|
|
$preset
|
|
);
|
|
_wp_array_set( $slugs, $metadata['path'], $slugs_for_preset );
|
|
}
|
|
|
|
return $slugs;
|
|
}
|
|
|
|
/**
|
|
* Removes the preset values whose slug is equal to any of given slugs.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $node The node with the presets to validate.
|
|
* @param array $path The path to the preset type to inspect.
|
|
* @param array $slugs The slugs that should not be overriden.
|
|
*
|
|
* @return array The new node
|
|
*/
|
|
private static function filter_slugs( $node, $path, $slugs ) {
|
|
$slugs_for_preset = _wp_array_get( $slugs, $path, array() );
|
|
if ( empty( $slugs_for_preset ) ) {
|
|
return $node;
|
|
}
|
|
|
|
$new_node = array();
|
|
foreach ( $node as $value ) {
|
|
if ( isset( $value['slug'] ) && ! in_array( $value['slug'], $slugs_for_preset, true ) ) {
|
|
$new_node[] = $value;
|
|
}
|
|
}
|
|
|
|
return $new_node;
|
|
}
|
|
|
|
/**
|
|
* Removes insecure data from theme.json.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $theme_json Structure to sanitize.
|
|
* @return array Sanitized structure.
|
|
*/
|
|
public static function remove_insecure_properties( $theme_json ) {
|
|
$sanitized = array();
|
|
|
|
$theme_json = WP_Theme_JSON_Schema::migrate( $theme_json );
|
|
|
|
$valid_block_names = array_keys( self::get_blocks_metadata() );
|
|
$valid_element_names = array_keys( self::ELEMENTS );
|
|
$theme_json = self::sanitize( $theme_json, $valid_block_names, $valid_element_names );
|
|
|
|
$blocks_metadata = self::get_blocks_metadata();
|
|
$style_nodes = self::get_style_nodes( $theme_json, $blocks_metadata );
|
|
foreach ( $style_nodes as $metadata ) {
|
|
$input = _wp_array_get( $theme_json, $metadata['path'], array() );
|
|
if ( empty( $input ) ) {
|
|
continue;
|
|
}
|
|
|
|
$output = self::remove_insecure_styles( $input );
|
|
if ( ! empty( $output ) ) {
|
|
_wp_array_set( $sanitized, $metadata['path'], $output );
|
|
}
|
|
}
|
|
|
|
$setting_nodes = self::get_setting_nodes( $theme_json );
|
|
foreach ( $setting_nodes as $metadata ) {
|
|
$input = _wp_array_get( $theme_json, $metadata['path'], array() );
|
|
if ( empty( $input ) ) {
|
|
continue;
|
|
}
|
|
|
|
$output = self::remove_insecure_settings( $input );
|
|
if ( ! empty( $output ) ) {
|
|
_wp_array_set( $sanitized, $metadata['path'], $output );
|
|
}
|
|
}
|
|
|
|
if ( empty( $sanitized['styles'] ) ) {
|
|
unset( $theme_json['styles'] );
|
|
} else {
|
|
$theme_json['styles'] = $sanitized['styles'];
|
|
}
|
|
|
|
if ( empty( $sanitized['settings'] ) ) {
|
|
unset( $theme_json['settings'] );
|
|
} else {
|
|
$theme_json['settings'] = $sanitized['settings'];
|
|
}
|
|
|
|
return $theme_json;
|
|
}
|
|
|
|
/**
|
|
* Processes a setting node and returns the same node
|
|
* without the insecure settings.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $input Node to process.
|
|
* @return array
|
|
*/
|
|
private static function remove_insecure_settings( $input ) {
|
|
$output = array();
|
|
foreach ( self::PRESETS_METADATA as $preset_metadata ) {
|
|
foreach ( self::VALID_ORIGINS as $origin ) {
|
|
$path_with_origin = array_merge( $preset_metadata['path'], array( $origin ) );
|
|
$presets = _wp_array_get( $input, $path_with_origin, null );
|
|
if ( null === $presets ) {
|
|
continue;
|
|
}
|
|
|
|
$escaped_preset = array();
|
|
foreach ( $presets as $preset ) {
|
|
if (
|
|
esc_attr( esc_html( $preset['name'] ) ) === $preset['name'] &&
|
|
sanitize_html_class( $preset['slug'] ) === $preset['slug']
|
|
) {
|
|
$value = null;
|
|
if ( isset( $preset_metadata['value_key'] ) ) {
|
|
$value = $preset[ $preset_metadata['value_key'] ];
|
|
} elseif (
|
|
isset( $preset_metadata['value_func'] ) &&
|
|
is_callable( $preset_metadata['value_func'] )
|
|
) {
|
|
$value = call_user_func( $preset_metadata['value_func'], $preset );
|
|
}
|
|
|
|
$preset_is_valid = true;
|
|
foreach ( $preset_metadata['properties'] as $property ) {
|
|
if ( ! self::is_safe_css_declaration( $property, $value ) ) {
|
|
$preset_is_valid = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ( $preset_is_valid ) {
|
|
$escaped_preset[] = $preset;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( ! empty( $escaped_preset ) ) {
|
|
_wp_array_set( $output, $path_with_origin, $escaped_preset );
|
|
}
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Processes a style node and returns the same node
|
|
* without the insecure styles.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param array $input Node to process.
|
|
* @return array
|
|
*/
|
|
private static function remove_insecure_styles( $input ) {
|
|
$output = array();
|
|
$declarations = self::compute_style_properties( $input );
|
|
|
|
foreach ( $declarations as $declaration ) {
|
|
if ( self::is_safe_css_declaration( $declaration['name'], $declaration['value'] ) ) {
|
|
$path = self::PROPERTIES_METADATA[ $declaration['name'] ];
|
|
|
|
// Check the value isn't an array before adding so as to not
|
|
// double up shorthand and longhand styles.
|
|
$value = _wp_array_get( $input, $path, array() );
|
|
if ( ! is_array( $value ) ) {
|
|
_wp_array_set( $output, $path, $value );
|
|
}
|
|
}
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Checks that a declaration provided by the user is safe.
|
|
*
|
|
* @since 5.9.0
|
|
*
|
|
* @param string $property_name Property name in a CSS declaration, i.e. the `color` in `color: red`.
|
|
* @param string $property_value Value in a CSS declaration, i.e. the `red` in `color: red`.
|
|
* @return boolean
|
|
*/
|
|
private static function is_safe_css_declaration( $property_name, $property_value ) {
|
|
$style_to_validate = $property_name . ': ' . $property_value;
|
|
$filtered = esc_html( safecss_filter_attr( $style_to_validate ) );
|
|
return ! empty( trim( $filtered ) );
|
|
}
|
|
|
|
/**
|
|
* Returns the raw data.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @return array Raw data.
|
|
*/
|
|
public function get_raw_data() {
|
|
return $this->theme_json;
|
|
}
|
|
|
|
/**
|
|
* Transforms the given editor settings according the
|
|
* add_theme_support format to the theme.json format.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param array $settings Existing editor settings.
|
|
* @return array Config that adheres to the theme.json schema.
|
|
*/
|
|
public static function get_from_editor_settings( $settings ) {
|
|
$theme_settings = array(
|
|
'version' => self::LATEST_SCHEMA,
|
|
'settings' => array(),
|
|
);
|
|
|
|
// Deprecated theme supports.
|
|
if ( isset( $settings['disableCustomColors'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['color'] ) ) {
|
|
$theme_settings['settings']['color'] = array();
|
|
}
|
|
$theme_settings['settings']['color']['custom'] = ! $settings['disableCustomColors'];
|
|
}
|
|
|
|
if ( isset( $settings['disableCustomGradients'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['color'] ) ) {
|
|
$theme_settings['settings']['color'] = array();
|
|
}
|
|
$theme_settings['settings']['color']['customGradient'] = ! $settings['disableCustomGradients'];
|
|
}
|
|
|
|
if ( isset( $settings['disableCustomFontSizes'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['typography'] ) ) {
|
|
$theme_settings['settings']['typography'] = array();
|
|
}
|
|
$theme_settings['settings']['typography']['customFontSize'] = ! $settings['disableCustomFontSizes'];
|
|
}
|
|
|
|
if ( isset( $settings['enableCustomLineHeight'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['typography'] ) ) {
|
|
$theme_settings['settings']['typography'] = array();
|
|
}
|
|
$theme_settings['settings']['typography']['lineHeight'] = $settings['enableCustomLineHeight'];
|
|
}
|
|
|
|
if ( isset( $settings['enableCustomUnits'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['spacing'] ) ) {
|
|
$theme_settings['settings']['spacing'] = array();
|
|
}
|
|
$theme_settings['settings']['spacing']['units'] = ( true === $settings['enableCustomUnits'] ) ?
|
|
array( 'px', 'em', 'rem', 'vh', 'vw', '%' ) :
|
|
$settings['enableCustomUnits'];
|
|
}
|
|
|
|
if ( isset( $settings['colors'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['color'] ) ) {
|
|
$theme_settings['settings']['color'] = array();
|
|
}
|
|
$theme_settings['settings']['color']['palette'] = $settings['colors'];
|
|
}
|
|
|
|
if ( isset( $settings['gradients'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['color'] ) ) {
|
|
$theme_settings['settings']['color'] = array();
|
|
}
|
|
$theme_settings['settings']['color']['gradients'] = $settings['gradients'];
|
|
}
|
|
|
|
if ( isset( $settings['fontSizes'] ) ) {
|
|
$font_sizes = $settings['fontSizes'];
|
|
// Back-compatibility for presets without units.
|
|
foreach ( $font_sizes as $key => $font_size ) {
|
|
if ( is_numeric( $font_size['size'] ) ) {
|
|
$font_sizes[ $key ]['size'] = $font_size['size'] . 'px';
|
|
}
|
|
}
|
|
if ( ! isset( $theme_settings['settings']['typography'] ) ) {
|
|
$theme_settings['settings']['typography'] = array();
|
|
}
|
|
$theme_settings['settings']['typography']['fontSizes'] = $font_sizes;
|
|
}
|
|
|
|
if ( isset( $settings['enableCustomSpacing'] ) ) {
|
|
if ( ! isset( $theme_settings['settings']['spacing'] ) ) {
|
|
$theme_settings['settings']['spacing'] = array();
|
|
}
|
|
$theme_settings['settings']['spacing']['padding'] = $settings['enableCustomSpacing'];
|
|
}
|
|
|
|
return $theme_settings;
|
|
}
|
|
|
|
}
|