2022-09-14 08:48:16 -04:00
|
|
|
<?php
|
|
|
|
/**
|
2023-05-09 06:37:22 -04:00
|
|
|
* Style Engine: WP_Style_Engine class
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage StyleEngine
|
|
|
|
* @since 6.1.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2023-05-09 06:37:22 -04:00
|
|
|
* The main class integrating all other WP_Style_Engine_* classes.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* The Style Engine aims to provide a consistent API for rendering styling for blocks
|
|
|
|
* across both client-side and server-side applications.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
2022-09-29 14:05:09 -04:00
|
|
|
* This class is final and should not be extended.
|
2023-05-17 07:58:26 -04:00
|
|
|
*
|
|
|
|
* 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 wp_style_engine_get_styles() instead.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @access private
|
|
|
|
* @since 6.1.0
|
2023-06-22 04:18:19 -04:00
|
|
|
* @since 6.3.0 Added support for text-columns.
|
2023-09-18 21:29:23 -04:00
|
|
|
* @since 6.4.0 Added support for background.backgroundImage.
|
2024-01-30 21:54:17 -05:00
|
|
|
* @since 6.5.0 Added support for background.backgroundPosition,
|
|
|
|
* background.backgroundRepeat and dimensions.aspectRatio.
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
Code Modernization: Add `AllowDynamicProperties` attribute to recently introduced classes.
This commit is a follow-up to [54133] for new classes introduced in WordPress 6.1 since the previous commit.
Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.
There are a number of ways to mitigate this:
* If it is an accidental typo for a declared property: fix the typo.
* For known properties: declare them on the class.
* For unknown properties: add the magic `__get()`, `__set()`, et al. methods to the class or let the class extend `stdClass` which has highly optimized versions of these magic methods built in.
* For unknown ''use'' of dynamic properties, the `#[AllowDynamicProperties]` attribute can be added to the class. The attribute will automatically be inherited by child classes.
Trac ticket #56034 is open to investigate and handle the third and fourth type of situations, however it has become clear this will need more time and will not be ready in time for WP 6.1.
To reduce “noise” in the meantime, both in the error logs of WP users moving onto PHP 8.2, in the test run logs of WP itself, in test runs of plugins and themes, as well as to prevent duplicate tickets from being opened for the same issue, the `#[AllowDynamicProperties]` attribute has been added to all “parent” classes in WP.
Reference: [https://wiki.php.net/rfc/deprecate_dynamic_properties PHP RFC: Deprecate dynamic properties].
Follow-up to [53922], [54133].
Props jrf.
See #56513, #56034.
Built from https://develop.svn.wordpress.org/trunk@54481
git-svn-id: http://core.svn.wordpress.org/trunk@54040 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-10-11 11:00:12 -04:00
|
|
|
#[AllowDynamicProperties]
|
2022-09-29 14:05:09 -04:00
|
|
|
final class WP_Style_Engine {
|
2022-09-14 08:48:16 -04:00
|
|
|
/**
|
2023-09-20 03:06:20 -04:00
|
|
|
* Style definitions that contain the instructions to parse/output valid Gutenberg styles from a block's attributes.
|
2023-05-17 07:58:26 -04:00
|
|
|
*
|
2023-09-20 20:18:23 -04:00
|
|
|
* For every style definition, the following properties are valid:
|
2023-05-17 07:58:26 -04:00
|
|
|
*
|
2023-09-20 03:06:20 -04:00
|
|
|
* - classnames => (array) an array of classnames to be returned for block styles. The key is a classname or pattern.
|
|
|
|
* A value of `true` means the classname should be applied always. Otherwise, a valid CSS property (string)
|
|
|
|
* to match the incoming value, e.g., "color" to match var:preset|color|somePresetSlug.
|
|
|
|
* - css_vars => (array) an array of key value pairs used to generate CSS var values.
|
|
|
|
* The key should be the CSS property name that matches the second element of the preset string value,
|
|
|
|
* i.e., "color" in var:preset|color|somePresetSlug. The value is a CSS var pattern (e.g. `--wp--preset--color--$slug`),
|
|
|
|
* whose `$slug` fragment will be replaced with the preset slug, which is the third element of the preset string value,
|
|
|
|
* i.e., `somePresetSlug` in var:preset|color|somePresetSlug.
|
|
|
|
* - property_keys => (array) array of keys whose values represent a valid CSS property, e.g., "margin" or "border".
|
|
|
|
* - path => (array) a path that accesses the corresponding style value in the block style object.
|
|
|
|
* - value_func => (string) the name of a function to generate a CSS definition array for a particular style object. The output of this function should be `array( "$property" => "$value", ... )`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
const BLOCK_STYLE_DEFINITIONS_METADATA = array(
|
2023-09-18 21:29:23 -04:00
|
|
|
'background' => array(
|
2024-01-09 01:12:18 -05:00
|
|
|
'backgroundImage' => array(
|
2023-09-18 21:29:23 -04:00
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'background-image',
|
|
|
|
),
|
|
|
|
'value_func' => array( self::class, 'get_url_or_value_css_declaration' ),
|
|
|
|
'path' => array( 'background', 'backgroundImage' ),
|
|
|
|
),
|
2024-01-09 01:12:18 -05:00
|
|
|
'backgroundPosition' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'background-position',
|
|
|
|
),
|
|
|
|
'path' => array( 'background', 'backgroundPosition' ),
|
|
|
|
),
|
|
|
|
'backgroundRepeat' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'background-repeat',
|
|
|
|
),
|
|
|
|
'path' => array( 'background', 'backgroundRepeat' ),
|
|
|
|
),
|
|
|
|
'backgroundSize' => array(
|
2023-09-18 21:29:23 -04:00
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'background-size',
|
|
|
|
),
|
|
|
|
'path' => array( 'background', 'backgroundSize' ),
|
|
|
|
),
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'color' => array(
|
|
|
|
'text' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'color',
|
|
|
|
),
|
|
|
|
'path' => array( 'color', 'text' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'color' => '--wp--preset--color--$slug',
|
|
|
|
),
|
|
|
|
'classnames' => array(
|
|
|
|
'has-text-color' => true,
|
|
|
|
'has-$slug-color' => 'color',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'background' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'background-color',
|
|
|
|
),
|
|
|
|
'path' => array( 'color', 'background' ),
|
2023-09-18 02:27:19 -04:00
|
|
|
'css_vars' => array(
|
|
|
|
'color' => '--wp--preset--color--$slug',
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'classnames' => array(
|
|
|
|
'has-background' => true,
|
|
|
|
'has-$slug-background-color' => 'color',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'gradient' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'background',
|
|
|
|
),
|
|
|
|
'path' => array( 'color', 'gradient' ),
|
2023-09-18 02:27:19 -04:00
|
|
|
'css_vars' => array(
|
|
|
|
'gradient' => '--wp--preset--gradient--$slug',
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'classnames' => array(
|
|
|
|
'has-background' => true,
|
|
|
|
'has-$slug-gradient-background' => 'gradient',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'border' => array(
|
|
|
|
'color' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'border-color',
|
|
|
|
'individual' => 'border-%s-color',
|
|
|
|
),
|
|
|
|
'path' => array( 'border', 'color' ),
|
|
|
|
'classnames' => array(
|
|
|
|
'has-border-color' => true,
|
|
|
|
'has-$slug-border-color' => 'color',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'radius' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'border-radius',
|
|
|
|
'individual' => 'border-%s-radius',
|
|
|
|
),
|
|
|
|
'path' => array( 'border', 'radius' ),
|
|
|
|
),
|
|
|
|
'style' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'border-style',
|
|
|
|
'individual' => 'border-%s-style',
|
|
|
|
),
|
|
|
|
'path' => array( 'border', 'style' ),
|
|
|
|
),
|
|
|
|
'width' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'border-width',
|
|
|
|
'individual' => 'border-%s-width',
|
|
|
|
),
|
|
|
|
'path' => array( 'border', 'width' ),
|
|
|
|
),
|
|
|
|
'top' => array(
|
2022-09-29 14:05:09 -04:00
|
|
|
'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
|
2022-09-14 08:48:16 -04:00
|
|
|
'path' => array( 'border', 'top' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'color' => '--wp--preset--color--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'right' => array(
|
2022-09-29 14:05:09 -04:00
|
|
|
'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
|
2022-09-14 08:48:16 -04:00
|
|
|
'path' => array( 'border', 'right' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'color' => '--wp--preset--color--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'bottom' => array(
|
2022-09-29 14:05:09 -04:00
|
|
|
'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
|
2022-09-14 08:48:16 -04:00
|
|
|
'path' => array( 'border', 'bottom' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'color' => '--wp--preset--color--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'left' => array(
|
2022-09-29 14:05:09 -04:00
|
|
|
'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
|
2022-09-14 08:48:16 -04:00
|
|
|
'path' => array( 'border', 'left' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'color' => '--wp--preset--color--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
),
|
2023-06-26 19:44:29 -04:00
|
|
|
'shadow' => array(
|
|
|
|
'shadow' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'box-shadow',
|
|
|
|
),
|
|
|
|
'path' => array( 'shadow' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'shadow' => '--wp--preset--shadow--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
),
|
Editor: Introduce minimum height dimensions block support.
This changeset adds the new dimension feature's PHP code for supporting minimum height in the block editor inspector and in global styles. Minimum height is quite useful for defining the minimum vertical dimensions of a block, while allowing it to expand beyond that size.
In this changeset:
* Adds support in `theme.json`.
* Adds support in the style engine.
* Adds support in `wp_apply_dimensions_support()`.
* Renames the setting from `'__experimentalDimensions'` to `dimensions` in `wp_register_dimensions_support()`.
* Adds PHPUnit tests.
Is renaming `'__experimentalDimensions'` a backwards-compatibility (BC) break?
Though the setting has been in the code since 5.9.0, it was never wired to anything, ie it did not expose any controls or styles. Notice in `wp_register_dimensions_support()` and `wp_apply_dimensions_support()` prior to this changeset, there are inline comments as placeholders for height and width support, but no code.
If a developer opted in to use it, it had no effect.
A search in wp.org's plugin and themes repo showed no instances of this experimental setting.
Given there was no functionality attached to it (until this changeset), no change in behavior or effect from removing it, and no usage found in the plugins and themes repository, it does appear to be a BC break.
References:
* [https://github.com/WordPress/gutenberg/pull/45300 Gutenberg PR 45300]
* [https://github.com/WordPress/gutenberg/pull/45334 Gutenberg PR 45334]
Follow-up to [53076], [52069].
Props andrewserong, aaronrobertshaw , costdev, hellofromTonya, isabel_brison, joen, paaljoachim, mukesh27, ntsekouras, oandregal, ramonopoly.
Fixes #57582.
Built from https://develop.svn.wordpress.org/trunk@55175
git-svn-id: http://core.svn.wordpress.org/trunk@54708 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-01 11:15:15 -05:00
|
|
|
'dimensions' => array(
|
2024-01-30 21:54:17 -05:00
|
|
|
'aspectRatio' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'aspect-ratio',
|
|
|
|
),
|
|
|
|
'path' => array( 'dimensions', 'aspectRatio' ),
|
|
|
|
'classnames' => array(
|
|
|
|
'has-aspect-ratio' => true,
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'minHeight' => array(
|
Editor: Introduce minimum height dimensions block support.
This changeset adds the new dimension feature's PHP code for supporting minimum height in the block editor inspector and in global styles. Minimum height is quite useful for defining the minimum vertical dimensions of a block, while allowing it to expand beyond that size.
In this changeset:
* Adds support in `theme.json`.
* Adds support in the style engine.
* Adds support in `wp_apply_dimensions_support()`.
* Renames the setting from `'__experimentalDimensions'` to `dimensions` in `wp_register_dimensions_support()`.
* Adds PHPUnit tests.
Is renaming `'__experimentalDimensions'` a backwards-compatibility (BC) break?
Though the setting has been in the code since 5.9.0, it was never wired to anything, ie it did not expose any controls or styles. Notice in `wp_register_dimensions_support()` and `wp_apply_dimensions_support()` prior to this changeset, there are inline comments as placeholders for height and width support, but no code.
If a developer opted in to use it, it had no effect.
A search in wp.org's plugin and themes repo showed no instances of this experimental setting.
Given there was no functionality attached to it (until this changeset), no change in behavior or effect from removing it, and no usage found in the plugins and themes repository, it does appear to be a BC break.
References:
* [https://github.com/WordPress/gutenberg/pull/45300 Gutenberg PR 45300]
* [https://github.com/WordPress/gutenberg/pull/45334 Gutenberg PR 45334]
Follow-up to [53076], [52069].
Props andrewserong, aaronrobertshaw , costdev, hellofromTonya, isabel_brison, joen, paaljoachim, mukesh27, ntsekouras, oandregal, ramonopoly.
Fixes #57582.
Built from https://develop.svn.wordpress.org/trunk@55175
git-svn-id: http://core.svn.wordpress.org/trunk@54708 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-02-01 11:15:15 -05:00
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'min-height',
|
|
|
|
),
|
|
|
|
'path' => array( 'dimensions', 'minHeight' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'spacing' => '--wp--preset--spacing--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'spacing' => array(
|
|
|
|
'padding' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'padding',
|
|
|
|
'individual' => 'padding-%s',
|
|
|
|
),
|
|
|
|
'path' => array( 'spacing', 'padding' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'spacing' => '--wp--preset--spacing--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'margin' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'margin',
|
|
|
|
'individual' => 'margin-%s',
|
|
|
|
),
|
|
|
|
'path' => array( 'spacing', 'margin' ),
|
|
|
|
'css_vars' => array(
|
|
|
|
'spacing' => '--wp--preset--spacing--$slug',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'typography' => array(
|
|
|
|
'fontSize' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'font-size',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'fontSize' ),
|
2024-01-08 21:45:16 -05:00
|
|
|
'css_vars' => array(
|
|
|
|
'font-size' => '--wp--preset--font-size--$slug',
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'classnames' => array(
|
|
|
|
'has-$slug-font-size' => 'font-size',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'fontFamily' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'font-family',
|
|
|
|
),
|
2024-01-08 21:45:16 -05:00
|
|
|
'css_vars' => array(
|
|
|
|
'font-family' => '--wp--preset--font-family--$slug',
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'path' => array( 'typography', 'fontFamily' ),
|
|
|
|
'classnames' => array(
|
|
|
|
'has-$slug-font-family' => 'font-family',
|
|
|
|
),
|
|
|
|
),
|
|
|
|
'fontStyle' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'font-style',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'fontStyle' ),
|
|
|
|
),
|
|
|
|
'fontWeight' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'font-weight',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'fontWeight' ),
|
|
|
|
),
|
|
|
|
'lineHeight' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'line-height',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'lineHeight' ),
|
|
|
|
),
|
2023-06-22 04:18:19 -04:00
|
|
|
'textColumns' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'column-count',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'textColumns' ),
|
|
|
|
),
|
2022-09-14 08:48:16 -04:00
|
|
|
'textDecoration' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'text-decoration',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'textDecoration' ),
|
|
|
|
),
|
|
|
|
'textTransform' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'text-transform',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'textTransform' ),
|
|
|
|
),
|
|
|
|
'letterSpacing' => array(
|
|
|
|
'property_keys' => array(
|
|
|
|
'default' => 'letter-spacing',
|
|
|
|
),
|
|
|
|
'path' => array( 'typography', 'letterSpacing' ),
|
|
|
|
),
|
|
|
|
),
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
2023-05-17 07:58:26 -04:00
|
|
|
* Util: Extracts the slug in kebab case from a preset string,
|
|
|
|
* e.g. `heavenly-blue` from `var:preset|color|heavenlyBlue`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param string $style_value A single CSS preset value.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param string $property_key The CSS property that is the second element of the preset string.
|
|
|
|
* Used for matching.
|
2022-09-14 08:48:16 -04:00
|
|
|
* @return string The slug, or empty string if not found.
|
|
|
|
*/
|
|
|
|
protected static function get_slug_from_preset_value( $style_value, $property_key ) {
|
2023-05-17 07:58:26 -04:00
|
|
|
if ( is_string( $style_value ) && is_string( $property_key )
|
|
|
|
&& str_contains( $style_value, "var:preset|{$property_key}|" )
|
|
|
|
) {
|
2022-09-14 08:48:16 -04:00
|
|
|
$index_to_splice = strrpos( $style_value, '|' ) + 1;
|
|
|
|
return _wp_to_kebab_case( substr( $style_value, $index_to_splice ) );
|
|
|
|
}
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-05-17 07:58:26 -04:00
|
|
|
* Util: Generates a CSS var string, e.g. `var(--wp--preset--color--background)`
|
|
|
|
* from a preset string such as `var:preset|space|50`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2023-05-03 19:57:18 -04:00
|
|
|
* @param string $style_value A single CSS preset value.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param string[] $css_vars An associate array of CSS var patterns
|
|
|
|
* used to generate the var string.
|
2023-05-03 19:57:18 -04:00
|
|
|
* @return string The CSS var, or an empty string if no match for slug found.
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
|
|
|
protected static function get_css_var_value( $style_value, $css_vars ) {
|
2023-05-03 19:57:18 -04:00
|
|
|
foreach ( $css_vars as $property_key => $css_var_pattern ) {
|
2022-09-14 08:48:16 -04:00
|
|
|
$slug = static::get_slug_from_preset_value( $style_value, $property_key );
|
|
|
|
if ( static::is_valid_style_value( $slug ) ) {
|
|
|
|
$var = strtr(
|
|
|
|
$css_var_pattern,
|
|
|
|
array( '$slug' => $slug )
|
|
|
|
);
|
|
|
|
return "var($var)";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Util: Checks whether an incoming block style value is valid.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param string $style_value A single CSS preset value.
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
protected static function is_valid_style_value( $style_value ) {
|
|
|
|
return '0' === $style_value || ! empty( $style_value );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Stores a CSS rule using the provided CSS selector and CSS declarations.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
2024-05-03 00:47:12 -04:00
|
|
|
* @since 6.6.0 Added the `$rules_group` parameter.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @param string $store_name A valid store key.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param string $css_selector When a selector is passed, the function will return
|
|
|
|
* a full CSS rule `$selector { ...rules }`
|
|
|
|
* otherwise a concatenated string of properties and values.
|
|
|
|
* @param string[] $css_declarations An associative array of CSS definitions,
|
|
|
|
* e.g. `array( "$property" => "$value", "$property" => "$value" )`.
|
2024-05-03 00:47:12 -04:00
|
|
|
* @param string $rules_group Optional. A parent CSS selector in the case of nested CSS, or a CSS nested @rule,
|
|
|
|
* such as `@media (min-width: 80rem)` or `@layer module`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
2024-05-03 00:47:12 -04:00
|
|
|
public static function store_css_rule( $store_name, $css_selector, $css_declarations, $rules_group = '' ) {
|
2022-09-14 08:48:16 -04:00
|
|
|
if ( empty( $store_name ) || empty( $css_selector ) || empty( $css_declarations ) ) {
|
|
|
|
return;
|
|
|
|
}
|
2024-05-03 00:47:12 -04:00
|
|
|
static::get_store( $store_name )->add_rule( $css_selector, $rules_group )->add_declarations( $css_declarations );
|
2022-09-14 08:48:16 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a store by store key.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param string $store_name A store key.
|
2023-05-03 19:57:18 -04:00
|
|
|
* @return WP_Style_Engine_CSS_Rules_Store|null
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
|
|
|
public static function get_store( $store_name ) {
|
|
|
|
return WP_Style_Engine_CSS_Rules_Store::get_store( $store_name );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns classnames and CSS based on the values in a styles object.
|
2023-05-17 07:58:26 -04:00
|
|
|
*
|
2022-09-14 08:48:16 -04:00
|
|
|
* Return values are parsed based on the instructions in BLOCK_STYLE_DEFINITIONS_METADATA.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
|
|
|
* @param array $block_styles The style object.
|
|
|
|
* @param array $options {
|
|
|
|
* Optional. An array of options. Default empty array.
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type bool $convert_vars_to_classnames Whether to skip converting incoming CSS var patterns,
|
|
|
|
* e.g. `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`,
|
|
|
|
* to `var( --wp--preset--* )` values. Default false.
|
|
|
|
* @type string $selector Optional. When a selector is passed,
|
|
|
|
* the value of `$css` in the return value will comprise
|
|
|
|
* a full CSS rule `$selector { ...$css_declarations }`,
|
|
|
|
* otherwise, the value will be a concatenated string
|
|
|
|
* of CSS declarations.
|
2022-09-14 08:48:16 -04:00
|
|
|
* }
|
|
|
|
* @return array {
|
2023-05-03 19:57:18 -04:00
|
|
|
* @type string[] $classnames Array of class names.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type string[] $declarations An associative array of CSS definitions,
|
|
|
|
* e.g. `array( "$property" => "$value", "$property" => "$value" )`.
|
2022-09-14 08:48:16 -04:00
|
|
|
* }
|
|
|
|
*/
|
|
|
|
public static function parse_block_styles( $block_styles, $options ) {
|
|
|
|
$parsed_styles = array(
|
|
|
|
'classnames' => array(),
|
|
|
|
'declarations' => array(),
|
|
|
|
);
|
|
|
|
if ( empty( $block_styles ) || ! is_array( $block_styles ) ) {
|
|
|
|
return $parsed_styles;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Collect CSS and classnames.
|
|
|
|
foreach ( static::BLOCK_STYLE_DEFINITIONS_METADATA as $definition_group_key => $definition_group_style ) {
|
|
|
|
if ( empty( $block_styles[ $definition_group_key ] ) ) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
foreach ( $definition_group_style as $style_definition ) {
|
|
|
|
$style_value = _wp_array_get( $block_styles, $style_definition['path'], null );
|
|
|
|
|
|
|
|
if ( ! static::is_valid_style_value( $style_value ) ) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
$parsed_styles['classnames'] = array_merge( $parsed_styles['classnames'], static::get_classnames( $style_value, $style_definition ) );
|
|
|
|
$parsed_styles['declarations'] = array_merge( $parsed_styles['declarations'], static::get_css_declarations( $style_value, $style_definition, $options ) );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $parsed_styles;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-05-17 07:58:26 -04:00
|
|
|
* Returns classnames, and generates classname(s) from a CSS preset property pattern,
|
|
|
|
* e.g. `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param string $style_value A single raw style value or CSS preset property
|
|
|
|
* from the `$block_styles` array.
|
2023-05-03 19:57:18 -04:00
|
|
|
* @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA.
|
|
|
|
* @return string[] An array of CSS classnames, or empty array if there are none.
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
|
|
|
protected static function get_classnames( $style_value, $style_definition ) {
|
|
|
|
if ( empty( $style_value ) ) {
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
$classnames = array();
|
|
|
|
if ( ! empty( $style_definition['classnames'] ) ) {
|
|
|
|
foreach ( $style_definition['classnames'] as $classname => $property_key ) {
|
|
|
|
if ( true === $property_key ) {
|
|
|
|
$classnames[] = $classname;
|
2024-06-03 18:04:13 -04:00
|
|
|
continue;
|
2022-09-14 08:48:16 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
$slug = static::get_slug_from_preset_value( $style_value, $property_key );
|
|
|
|
|
|
|
|
if ( $slug ) {
|
|
|
|
/*
|
|
|
|
* Right now we expect a classname pattern to be stored in BLOCK_STYLE_DEFINITIONS_METADATA.
|
|
|
|
* One day, if there are no stored schemata, we could allow custom patterns or
|
|
|
|
* generate classnames based on other properties
|
|
|
|
* such as a path or a value or a prefix passed in options.
|
|
|
|
*/
|
|
|
|
$classnames[] = strtr( $classname, array( '$slug' => $slug ) );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $classnames;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns an array of CSS declarations based on valid block style values.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2023-05-03 19:57:18 -04:00
|
|
|
* @param mixed $style_value A single raw style value from $block_styles array.
|
2022-09-14 08:48:16 -04:00
|
|
|
* @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA.
|
|
|
|
* @param array $options {
|
|
|
|
* Optional. An array of options. Default empty array.
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type bool $convert_vars_to_classnames Whether to skip converting incoming CSS var patterns,
|
|
|
|
* e.g. `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`,
|
|
|
|
* to `var( --wp--preset--* )` values. Default false.
|
2022-09-14 08:48:16 -04:00
|
|
|
* }
|
2023-05-17 07:58:26 -04:00
|
|
|
* @return string[] An associative array of CSS definitions, e.g. `array( "$property" => "$value", "$property" => "$value" )`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
|
|
|
protected static function get_css_declarations( $style_value, $style_definition, $options = array() ) {
|
|
|
|
if ( isset( $style_definition['value_func'] ) && is_callable( $style_definition['value_func'] ) ) {
|
|
|
|
return call_user_func( $style_definition['value_func'], $style_value, $style_definition, $options );
|
|
|
|
}
|
|
|
|
|
|
|
|
$css_declarations = array();
|
|
|
|
$style_property_keys = $style_definition['property_keys'];
|
|
|
|
$should_skip_css_vars = isset( $options['convert_vars_to_classnames'] ) && true === $options['convert_vars_to_classnames'];
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Build CSS var values from `var:preset|<PRESET_TYPE>|<PRESET_SLUG>` values, e.g, `var(--wp--css--rule-slug )`.
|
|
|
|
* Check if the value is a CSS preset and there's a corresponding css_var pattern in the style definition.
|
|
|
|
*/
|
|
|
|
if ( is_string( $style_value ) && str_contains( $style_value, 'var:' ) ) {
|
|
|
|
if ( ! $should_skip_css_vars && ! empty( $style_definition['css_vars'] ) ) {
|
|
|
|
$css_var = static::get_css_var_value( $style_value, $style_definition['css_vars'] );
|
|
|
|
if ( static::is_valid_style_value( $css_var ) ) {
|
|
|
|
$css_declarations[ $style_property_keys['default'] ] = $css_var;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $css_declarations;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Default rule builder.
|
|
|
|
* If the input contains an array, assume box model-like properties
|
|
|
|
* for styles such as margins and padding.
|
|
|
|
*/
|
|
|
|
if ( is_array( $style_value ) ) {
|
|
|
|
// Bail out early if the `'individual'` property is not defined.
|
|
|
|
if ( ! isset( $style_property_keys['individual'] ) ) {
|
|
|
|
return $css_declarations;
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ( $style_value as $key => $value ) {
|
|
|
|
if ( is_string( $value ) && str_contains( $value, 'var:' ) && ! $should_skip_css_vars && ! empty( $style_definition['css_vars'] ) ) {
|
|
|
|
$value = static::get_css_var_value( $value, $style_definition['css_vars'] );
|
|
|
|
}
|
|
|
|
|
|
|
|
$individual_property = sprintf( $style_property_keys['individual'], _wp_to_kebab_case( $key ) );
|
|
|
|
|
|
|
|
if ( $individual_property && static::is_valid_style_value( $value ) ) {
|
|
|
|
$css_declarations[ $individual_property ] = $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $css_declarations;
|
|
|
|
}
|
|
|
|
|
|
|
|
$css_declarations[ $style_property_keys['default'] ] = $style_value;
|
|
|
|
return $css_declarations;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Style value parser that returns a CSS definition array comprising style properties
|
|
|
|
* that have keys representing individual style properties, otherwise known as longhand CSS properties.
|
2023-05-03 19:57:18 -04:00
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
*
|
|
|
|
* "$style_property-$individual_feature: $value;"
|
|
|
|
*
|
|
|
|
* Which could represent the following:
|
|
|
|
*
|
|
|
|
* "border-{top|right|bottom|left}-{color|width|style}: {value};"
|
|
|
|
*
|
|
|
|
* or:
|
|
|
|
*
|
|
|
|
* "border-image-{outset|source|width|repeat|slice}: {value};"
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2023-05-03 19:57:18 -04:00
|
|
|
* @param array $style_value A single raw style value from `$block_styles` array.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param array $individual_property_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA
|
|
|
|
* representing an individual property of a CSS property,
|
|
|
|
* e.g. 'top' in 'border-top'.
|
2022-09-14 08:48:16 -04:00
|
|
|
* @param array $options {
|
|
|
|
* Optional. An array of options. Default empty array.
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type bool $convert_vars_to_classnames Whether to skip converting incoming CSS var patterns,
|
|
|
|
* e.g. `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`,
|
|
|
|
* to `var( --wp--preset--* )` values. Default false.
|
2022-09-14 08:48:16 -04:00
|
|
|
* }
|
2023-05-17 07:58:26 -04:00
|
|
|
* @return string[] An associative array of CSS definitions, e.g. `array( "$property" => "$value", "$property" => "$value" )`.
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
|
|
|
protected static function get_individual_property_css_declarations( $style_value, $individual_property_definition, $options = array() ) {
|
|
|
|
if ( ! is_array( $style_value ) || empty( $style_value ) || empty( $individual_property_definition['path'] ) ) {
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
2023-05-17 07:58:26 -04:00
|
|
|
* The first item in $individual_property_definition['path'] array
|
|
|
|
* tells us the style property, e.g. "border". We use this to get a corresponding
|
|
|
|
* CSS style definition such as "color" or "width" from the same group.
|
|
|
|
*
|
|
|
|
* The second item in $individual_property_definition['path'] array
|
|
|
|
* refers to the individual property marker, e.g. "top".
|
2022-09-14 08:48:16 -04:00
|
|
|
*/
|
|
|
|
$definition_group_key = $individual_property_definition['path'][0];
|
|
|
|
$individual_property_key = $individual_property_definition['path'][1];
|
|
|
|
$should_skip_css_vars = isset( $options['convert_vars_to_classnames'] ) && true === $options['convert_vars_to_classnames'];
|
|
|
|
$css_declarations = array();
|
|
|
|
|
|
|
|
foreach ( $style_value as $css_property => $value ) {
|
|
|
|
if ( empty( $value ) ) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Build a path to the individual rules in definitions.
|
|
|
|
$style_definition_path = array( $definition_group_key, $css_property );
|
|
|
|
$style_definition = _wp_array_get( static::BLOCK_STYLE_DEFINITIONS_METADATA, $style_definition_path, null );
|
|
|
|
|
|
|
|
if ( $style_definition && isset( $style_definition['property_keys']['individual'] ) ) {
|
|
|
|
// Set a CSS var if there is a valid preset value.
|
2023-05-17 07:58:26 -04:00
|
|
|
if ( is_string( $value ) && str_contains( $value, 'var:' )
|
|
|
|
&& ! $should_skip_css_vars && ! empty( $individual_property_definition['css_vars'] )
|
|
|
|
) {
|
2022-09-14 08:48:16 -04:00
|
|
|
$value = static::get_css_var_value( $value, $individual_property_definition['css_vars'] );
|
|
|
|
}
|
2023-05-17 07:58:26 -04:00
|
|
|
|
|
|
|
$individual_css_property = sprintf( $style_definition['property_keys']['individual'], $individual_property_key );
|
|
|
|
|
2022-09-14 08:48:16 -04:00
|
|
|
$css_declarations[ $individual_css_property ] = $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $css_declarations;
|
|
|
|
}
|
|
|
|
|
2023-09-18 21:29:23 -04:00
|
|
|
/**
|
|
|
|
* Style value parser that constructs a CSS definition array comprising a single CSS property and value.
|
|
|
|
* If the provided value is an array containing a `url` property, the function will return a CSS definition array
|
|
|
|
* with a single property and value, with `url` escaped and injected into a CSS `url()` function,
|
|
|
|
* e.g., array( 'background-image' => "url( '...' )" ).
|
|
|
|
*
|
|
|
|
* @since 6.4.0
|
|
|
|
*
|
|
|
|
* @param array $style_value A single raw style value from $block_styles array.
|
|
|
|
* @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA.
|
|
|
|
* @return string[] An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ).
|
|
|
|
*/
|
|
|
|
protected static function get_url_or_value_css_declaration( $style_value, $style_definition ) {
|
|
|
|
if ( empty( $style_value ) ) {
|
|
|
|
return array();
|
|
|
|
}
|
|
|
|
|
|
|
|
$css_declarations = array();
|
|
|
|
|
|
|
|
if ( isset( $style_definition['property_keys']['default'] ) ) {
|
|
|
|
$value = null;
|
|
|
|
|
|
|
|
if ( ! empty( $style_value['url'] ) ) {
|
|
|
|
$value = "url('" . $style_value['url'] . "')";
|
|
|
|
} elseif ( is_string( $style_value ) ) {
|
|
|
|
$value = $style_value;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( null !== $value ) {
|
|
|
|
$css_declarations[ $style_definition['property_keys']['default'] ] = $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $css_declarations;
|
|
|
|
}
|
|
|
|
|
2022-09-14 08:48:16 -04:00
|
|
|
/**
|
2023-05-03 19:57:18 -04:00
|
|
|
* Returns compiled CSS from CSS declarations.
|
2022-09-14 08:48:16 -04:00
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param string[] $css_declarations An associative array of CSS definitions,
|
|
|
|
* e.g. `array( "$property" => "$value", "$property" => "$value" )`.
|
|
|
|
* @param string $css_selector When a selector is passed, the function will return
|
|
|
|
* a full CSS rule `$selector { ...rules }`,
|
|
|
|
* otherwise a concatenated string of properties and values.
|
2022-09-14 08:48:16 -04:00
|
|
|
* @return string A compiled CSS string.
|
|
|
|
*/
|
|
|
|
public static function compile_css( $css_declarations, $css_selector ) {
|
|
|
|
if ( empty( $css_declarations ) || ! is_array( $css_declarations ) ) {
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
|
|
|
|
// Return an entire rule if there is a selector.
|
|
|
|
if ( $css_selector ) {
|
|
|
|
$css_rule = new WP_Style_Engine_CSS_Rule( $css_selector, $css_declarations );
|
|
|
|
return $css_rule->get_css();
|
|
|
|
}
|
|
|
|
|
|
|
|
$css_declarations = new WP_Style_Engine_CSS_Declarations( $css_declarations );
|
|
|
|
return $css_declarations->get_declarations_string();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a compiled stylesheet from stored CSS rules.
|
|
|
|
*
|
|
|
|
* @since 6.1.0
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @param WP_Style_Engine_CSS_Rule[] $css_rules An array of WP_Style_Engine_CSS_Rule objects
|
|
|
|
* from a store or otherwise.
|
2022-09-14 08:48:16 -04:00
|
|
|
* @param array $options {
|
|
|
|
* Optional. An array of options. Default empty array.
|
|
|
|
*
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type string|null $context An identifier describing the origin of the style object,
|
|
|
|
* e.g. 'block-supports' or 'global-styles'. Default 'block-supports'.
|
2023-05-03 19:57:18 -04:00
|
|
|
* When set, the style engine will attempt to store the CSS rules.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type bool $optimize Whether to optimize the CSS output, e.g. combine rules.
|
2023-09-14 00:56:21 -04:00
|
|
|
* Default false.
|
2023-05-17 07:58:26 -04:00
|
|
|
* @type bool $prettify Whether to add new lines and indents to output.
|
|
|
|
* Defaults to whether the `SCRIPT_DEBUG` constant is defined.
|
2022-09-14 08:48:16 -04:00
|
|
|
* }
|
|
|
|
* @return string A compiled stylesheet from stored CSS rules.
|
|
|
|
*/
|
|
|
|
public static function compile_stylesheet_from_css_rules( $css_rules, $options = array() ) {
|
|
|
|
$processor = new WP_Style_Engine_Processor();
|
|
|
|
$processor->add_rules( $css_rules );
|
|
|
|
return $processor->get_css( $options );
|
|
|
|
}
|
|
|
|
}
|