summaryrefslogtreecommitdiffstats
path: root/wp-includes/style-engine
diff options
context:
space:
mode:
Diffstat (limited to 'wp-includes/style-engine')
-rw-r--r--wp-includes/style-engine/class-wp-style-engine-css-declarations.php187
-rw-r--r--wp-includes/style-engine/class-wp-style-engine-css-rule.php139
-rw-r--r--wp-includes/style-engine/class-wp-style-engine-css-rules-store.php155
-rw-r--r--wp-includes/style-engine/class-wp-style-engine-processor.php162
-rw-r--r--wp-includes/style-engine/class-wp-style-engine.php691
5 files changed, 1334 insertions, 0 deletions
diff --git a/wp-includes/style-engine/class-wp-style-engine-css-declarations.php b/wp-includes/style-engine/class-wp-style-engine-css-declarations.php
new file mode 100644
index 0000000..fbcb54b
--- /dev/null
+++ b/wp-includes/style-engine/class-wp-style-engine-css-declarations.php
@@ -0,0 +1,187 @@
+<?php
+/**
+ * Style Engine: WP_Style_Engine_CSS_Declarations class
+ *
+ * @package WordPress
+ * @subpackage StyleEngine
+ * @since 6.1.0
+ */
+
+/**
+ * Core class used for style engine CSS declarations.
+ *
+ * Holds, sanitizes, processes, and prints CSS declarations for the style engine.
+ *
+ * @since 6.1.0
+ */
+#[AllowDynamicProperties]
+class WP_Style_Engine_CSS_Declarations {
+
+ /**
+ * An array of CSS declarations (property => value pairs).
+ *
+ * @since 6.1.0
+ *
+ * @var string[]
+ */
+ protected $declarations = array();
+
+ /**
+ * Constructor for this object.
+ *
+ * If a `$declarations` array is passed, it will be used to populate
+ * the initial `$declarations` prop of the object by calling add_declarations().
+ *
+ * @since 6.1.0
+ *
+ * @param string[] $declarations Optional. An associative array of CSS definitions,
+ * e.g. `array( "$property" => "$value", "$property" => "$value" )`.
+ * Default empty array.
+ */
+ public function __construct( $declarations = array() ) {
+ $this->add_declarations( $declarations );
+ }
+
+ /**
+ * Adds a single declaration.
+ *
+ * @since 6.1.0
+ *
+ * @param string $property The CSS property.
+ * @param string $value The CSS value.
+ * @return WP_Style_Engine_CSS_Declarations Returns the object to allow chaining methods.
+ */
+ public function add_declaration( $property, $value ) {
+ // Sanitizes the property.
+ $property = $this->sanitize_property( $property );
+ // Bails early if the property is empty.
+ if ( empty( $property ) ) {
+ return $this;
+ }
+
+ // Trims the value. If empty, bail early.
+ $value = trim( $value );
+ if ( '' === $value ) {
+ return $this;
+ }
+
+ // Adds the declaration property/value pair.
+ $this->declarations[ $property ] = $value;
+
+ return $this;
+ }
+
+ /**
+ * Removes a single declaration.
+ *
+ * @since 6.1.0
+ *
+ * @param string $property The CSS property.
+ * @return WP_Style_Engine_CSS_Declarations Returns the object to allow chaining methods.
+ */
+ public function remove_declaration( $property ) {
+ unset( $this->declarations[ $property ] );
+ return $this;
+ }
+
+ /**
+ * Adds multiple declarations.
+ *
+ * @since 6.1.0
+ *
+ * @param string[] $declarations An array of declarations.
+ * @return WP_Style_Engine_CSS_Declarations Returns the object to allow chaining methods.
+ */
+ public function add_declarations( $declarations ) {
+ foreach ( $declarations as $property => $value ) {
+ $this->add_declaration( $property, $value );
+ }
+ return $this;
+ }
+
+ /**
+ * Removes multiple declarations.
+ *
+ * @since 6.1.0
+ *
+ * @param string[] $properties Optional. An array of properties. Default empty array.
+ * @return WP_Style_Engine_CSS_Declarations Returns the object to allow chaining methods.
+ */
+ public function remove_declarations( $properties = array() ) {
+ foreach ( $properties as $property ) {
+ $this->remove_declaration( $property );
+ }
+ return $this;
+ }
+
+ /**
+ * Gets the declarations array.
+ *
+ * @since 6.1.0
+ *
+ * @return string[] The declarations array.
+ */
+ public function get_declarations() {
+ return $this->declarations;
+ }
+
+ /**
+ * Filters a CSS property + value pair.
+ *
+ * @since 6.1.0
+ *
+ * @param string $property The CSS property.
+ * @param string $value The value to be filtered.
+ * @param string $spacer Optional. The spacer between the colon and the value.
+ * Default empty string.
+ * @return string The filtered declaration or an empty string.
+ */
+ protected static function filter_declaration( $property, $value, $spacer = '' ) {
+ $filtered_value = wp_strip_all_tags( $value, true );
+ if ( '' !== $filtered_value ) {
+ return safecss_filter_attr( "{$property}:{$spacer}{$filtered_value}" );
+ }
+ return '';
+ }
+
+ /**
+ * Filters and compiles the CSS declarations.
+ *
+ * @since 6.1.0
+ *
+ * @param bool $should_prettify Optional. Whether to add spacing, new lines and indents.
+ * Default false.
+ * @param int $indent_count Optional. The number of tab indents to apply to the rule.
+ * Applies if `prettify` is `true`. Default 0.
+ * @return string The CSS declarations.
+ */
+ public function get_declarations_string( $should_prettify = false, $indent_count = 0 ) {
+ $declarations_array = $this->get_declarations();
+ $declarations_output = '';
+ $indent = $should_prettify ? str_repeat( "\t", $indent_count ) : '';
+ $suffix = $should_prettify ? ' ' : '';
+ $suffix = $should_prettify && $indent_count > 0 ? "\n" : $suffix;
+ $spacer = $should_prettify ? ' ' : '';
+
+ foreach ( $declarations_array as $property => $value ) {
+ $filtered_declaration = static::filter_declaration( $property, $value, $spacer );
+ if ( $filtered_declaration ) {
+ $declarations_output .= "{$indent}{$filtered_declaration};$suffix";
+ }
+ }
+
+ return rtrim( $declarations_output );
+ }
+
+ /**
+ * Sanitizes property names.
+ *
+ * @since 6.1.0
+ *
+ * @param string $property The CSS property.
+ * @return string The sanitized property name.
+ */
+ protected function sanitize_property( $property ) {
+ return sanitize_key( $property );
+ }
+}
diff --git a/wp-includes/style-engine/class-wp-style-engine-css-rule.php b/wp-includes/style-engine/class-wp-style-engine-css-rule.php
new file mode 100644
index 0000000..2b31cff
--- /dev/null
+++ b/wp-includes/style-engine/class-wp-style-engine-css-rule.php
@@ -0,0 +1,139 @@
+<?php
+/**
+ * Style Engine: WP_Style_Engine_CSS_Rule class
+ *
+ * @package WordPress
+ * @subpackage StyleEngine
+ * @since 6.1.0
+ */
+
+/**
+ * Core class used for style engine CSS rules.
+ *
+ * Holds, sanitizes, processes, and prints CSS declarations for the style engine.
+ *
+ * @since 6.1.0
+ */
+#[AllowDynamicProperties]
+class WP_Style_Engine_CSS_Rule {
+
+ /**
+ * The selector.
+ *
+ * @since 6.1.0
+ * @var string
+ */
+ protected $selector;
+
+ /**
+ * The selector declarations.
+ *
+ * Contains a WP_Style_Engine_CSS_Declarations object.
+ *
+ * @since 6.1.0
+ * @var WP_Style_Engine_CSS_Declarations
+ */
+ protected $declarations;
+
+ /**
+ * Constructor.
+ *
+ * @since 6.1.0
+ *
+ * @param string $selector Optional. The CSS selector. Default empty string.
+ * @param string[]|WP_Style_Engine_CSS_Declarations $declarations Optional. An associative array of CSS definitions,
+ * e.g. `array( "$property" => "$value", "$property" => "$value" )`,
+ * or a WP_Style_Engine_CSS_Declarations object.
+ * Default empty array.
+ */
+ public function __construct( $selector = '', $declarations = array() ) {
+ $this->set_selector( $selector );
+ $this->add_declarations( $declarations );
+ }
+
+ /**
+ * Sets the selector.
+ *
+ * @since 6.1.0
+ *
+ * @param string $selector The CSS selector.
+ * @return WP_Style_Engine_CSS_Rule Returns the object to allow chaining of methods.
+ */
+ public function set_selector( $selector ) {
+ $this->selector = $selector;
+ return $this;
+ }
+
+ /**
+ * Sets the declarations.
+ *
+ * @since 6.1.0
+ *
+ * @param string[]|WP_Style_Engine_CSS_Declarations $declarations An array of declarations (property => value pairs),
+ * or a WP_Style_Engine_CSS_Declarations object.
+ * @return WP_Style_Engine_CSS_Rule Returns the object to allow chaining of methods.
+ */
+ public function add_declarations( $declarations ) {
+ $is_declarations_object = ! is_array( $declarations );
+ $declarations_array = $is_declarations_object ? $declarations->get_declarations() : $declarations;
+
+ if ( null === $this->declarations ) {
+ if ( $is_declarations_object ) {
+ $this->declarations = $declarations;
+ return $this;
+ }
+ $this->declarations = new WP_Style_Engine_CSS_Declarations( $declarations_array );
+ }
+ $this->declarations->add_declarations( $declarations_array );
+
+ return $this;
+ }
+
+ /**
+ * Gets the declarations object.
+ *
+ * @since 6.1.0
+ *
+ * @return WP_Style_Engine_CSS_Declarations The declarations object.
+ */
+ public function get_declarations() {
+ return $this->declarations;
+ }
+
+ /**
+ * Gets the full selector.
+ *
+ * @since 6.1.0
+ *
+ * @return string
+ */
+ public function get_selector() {
+ return $this->selector;
+ }
+
+ /**
+ * Gets the CSS.
+ *
+ * @since 6.1.0
+ *
+ * @param bool $should_prettify Optional. Whether to add spacing, new lines and indents.
+ * Default false.
+ * @param int $indent_count Optional. The number of tab indents to apply to the rule.
+ * Applies if `prettify` is `true`. Default 0.
+ * @return string
+ */
+ public function get_css( $should_prettify = false, $indent_count = 0 ) {
+ $rule_indent = $should_prettify ? str_repeat( "\t", $indent_count ) : '';
+ $declarations_indent = $should_prettify ? $indent_count + 1 : 0;
+ $suffix = $should_prettify ? "\n" : '';
+ $spacer = $should_prettify ? ' ' : '';
+ $selector = $should_prettify ? str_replace( ',', ",\n", $this->get_selector() ) : $this->get_selector();
+ $css_declarations = $this->declarations->get_declarations_string( $should_prettify, $declarations_indent );
+
+ if ( empty( $css_declarations ) ) {
+ return '';
+ }
+
+ return "{$rule_indent}{$selector}{$spacer}{{$suffix}{$css_declarations}{$suffix}{$rule_indent}}";
+ }
+}
diff --git a/wp-includes/style-engine/class-wp-style-engine-css-rules-store.php b/wp-includes/style-engine/class-wp-style-engine-css-rules-store.php
new file mode 100644
index 0000000..371e59f
--- /dev/null
+++ b/wp-includes/style-engine/class-wp-style-engine-css-rules-store.php
@@ -0,0 +1,155 @@
+<?php
+/**
+ * Style Engine: WP_Style_Engine_CSS_Rules_Store class
+ *
+ * @package WordPress
+ * @subpackage StyleEngine
+ * @since 6.1.0
+ */
+
+/**
+ * Core class used as a store for WP_Style_Engine_CSS_Rule objects.
+ *
+ * Holds, sanitizes, processes, and prints CSS declarations for the style engine.
+ *
+ * @since 6.1.0
+ */
+#[AllowDynamicProperties]
+class WP_Style_Engine_CSS_Rules_Store {
+
+ /**
+ * An array of named WP_Style_Engine_CSS_Rules_Store objects.
+ *
+ * @static
+ *
+ * @since 6.1.0
+ * @var WP_Style_Engine_CSS_Rules_Store[]
+ */
+ protected static $stores = array();
+
+ /**
+ * The store name.
+ *
+ * @since 6.1.0
+ * @var string
+ */
+ protected $name = '';
+
+ /**
+ * An array of CSS Rules objects assigned to the store.
+ *
+ * @since 6.1.0
+ * @var WP_Style_Engine_CSS_Rule[]
+ */
+ protected $rules = array();
+
+ /**
+ * Gets an instance of the store.
+ *
+ * @since 6.1.0
+ *
+ * @param string $store_name The name of the store.
+ * @return WP_Style_Engine_CSS_Rules_Store|void
+ */
+ public static function get_store( $store_name = 'default' ) {
+ if ( ! is_string( $store_name ) || empty( $store_name ) ) {
+ return;
+ }
+ if ( ! isset( static::$stores[ $store_name ] ) ) {
+ static::$stores[ $store_name ] = new static();
+ // Set the store name.
+ static::$stores[ $store_name ]->set_name( $store_name );
+ }
+ return static::$stores[ $store_name ];
+ }
+
+ /**
+ * Gets an array of all available stores.
+ *
+ * @since 6.1.0
+ *
+ * @return WP_Style_Engine_CSS_Rules_Store[]
+ */
+ public static function get_stores() {
+ return static::$stores;
+ }
+
+ /**
+ * Clears all stores from static::$stores.
+ *
+ * @since 6.1.0
+ */
+ public static function remove_all_stores() {
+ static::$stores = array();
+ }
+
+ /**
+ * Sets the store name.
+ *
+ * @since 6.1.0
+ *
+ * @param string $name The store name.
+ */
+ public function set_name( $name ) {
+ $this->name = $name;
+ }
+
+ /**
+ * Gets the store name.
+ *
+ * @since 6.1.0
+ *
+ * @return string
+ */
+ public function get_name() {
+ return $this->name;
+ }
+
+ /**
+ * Gets an array of all rules.
+ *
+ * @since 6.1.0
+ *
+ * @return WP_Style_Engine_CSS_Rule[]
+ */
+ public function get_all_rules() {
+ return $this->rules;
+ }
+
+ /**
+ * Gets a WP_Style_Engine_CSS_Rule object by its selector.
+ * If the rule does not exist, it will be created.
+ *
+ * @since 6.1.0
+ *
+ * @param string $selector The CSS selector.
+ * @return WP_Style_Engine_CSS_Rule|void Returns a WP_Style_Engine_CSS_Rule object,
+ * or void if the selector is empty.
+ */
+ public function add_rule( $selector ) {
+ $selector = trim( $selector );
+
+ // Bail early if there is no selector.
+ if ( empty( $selector ) ) {
+ return;
+ }
+
+ // Create the rule if it doesn't exist.
+ if ( empty( $this->rules[ $selector ] ) ) {
+ $this->rules[ $selector ] = new WP_Style_Engine_CSS_Rule( $selector );
+ }
+
+ return $this->rules[ $selector ];
+ }
+
+ /**
+ * Removes a selector from the store.
+ *
+ * @since 6.1.0
+ *
+ * @param string $selector The CSS selector.
+ */
+ public function remove_rule( $selector ) {
+ unset( $this->rules[ $selector ] );
+ }
+}
diff --git a/wp-includes/style-engine/class-wp-style-engine-processor.php b/wp-includes/style-engine/class-wp-style-engine-processor.php
new file mode 100644
index 0000000..0778748
--- /dev/null
+++ b/wp-includes/style-engine/class-wp-style-engine-processor.php
@@ -0,0 +1,162 @@
+<?php
+/**
+ * Style Engine: WP_Style_Engine_Processor class
+ *
+ * @package WordPress
+ * @subpackage StyleEngine
+ * @since 6.1.0
+ */
+
+/**
+ * Core class used to compile styles from stores or collection of CSS rules.
+ *
+ * @since 6.1.0
+ */
+#[AllowDynamicProperties]
+class WP_Style_Engine_Processor {
+
+ /**
+ * A collection of Style Engine Store objects.
+ *
+ * @since 6.1.0
+ * @var WP_Style_Engine_CSS_Rules_Store[]
+ */
+ protected $stores = array();
+
+ /**
+ * The set of CSS rules that this processor will work on.
+ *
+ * @since 6.1.0
+ * @var WP_Style_Engine_CSS_Rule[]
+ */
+ protected $css_rules = array();
+
+ /**
+ * Adds a store to the processor.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Style_Engine_CSS_Rules_Store $store The store to add.
+ * @return WP_Style_Engine_Processor Returns the object to allow chaining methods.
+ */
+ public function add_store( $store ) {
+ if ( ! $store instanceof WP_Style_Engine_CSS_Rules_Store ) {
+ _doing_it_wrong(
+ __METHOD__,
+ __( '$store must be an instance of WP_Style_Engine_CSS_Rules_Store' ),
+ '6.1.0'
+ );
+ return $this;
+ }
+
+ $this->stores[ $store->get_name() ] = $store;
+
+ return $this;
+ }
+
+ /**
+ * Adds rules to be processed.
+ *
+ * @since 6.1.0
+ *
+ * @param WP_Style_Engine_CSS_Rule|WP_Style_Engine_CSS_Rule[] $css_rules A single, or an array of,
+ * WP_Style_Engine_CSS_Rule objects
+ * from a store or otherwise.
+ * @return WP_Style_Engine_Processor Returns the object to allow chaining methods.
+ */
+ public function add_rules( $css_rules ) {
+ if ( ! is_array( $css_rules ) ) {
+ $css_rules = array( $css_rules );
+ }
+
+ foreach ( $css_rules as $rule ) {
+ $selector = $rule->get_selector();
+ if ( isset( $this->css_rules[ $selector ] ) ) {
+ $this->css_rules[ $selector ]->add_declarations( $rule->get_declarations() );
+ continue;
+ }
+ $this->css_rules[ $rule->get_selector() ] = $rule;
+ }
+
+ return $this;
+ }
+
+ /**
+ * Gets the CSS rules as a string.
+ *
+ * @since 6.1.0
+ * @since 6.4.0 The Optimization is no longer the default.
+ *
+ * @param array $options {
+ * Optional. An array of options. Default empty array.
+ *
+ * @type bool $optimize Whether to optimize the CSS output, e.g. combine rules.
+ * Default false.
+ * @type bool $prettify Whether to add new lines and indents to output.
+ * Defaults to whether the `SCRIPT_DEBUG` constant is defined.
+ * }
+ * @return string The computed CSS.
+ */
+ public function get_css( $options = array() ) {
+ $defaults = array(
+ 'optimize' => false,
+ 'prettify' => defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG,
+ );
+ $options = wp_parse_args( $options, $defaults );
+
+ // If we have stores, get the rules from them.
+ foreach ( $this->stores as $store ) {
+ $this->add_rules( $store->get_all_rules() );
+ }
+
+ // Combine CSS selectors that have identical declarations.
+ if ( true === $options['optimize'] ) {
+ $this->combine_rules_selectors();
+ }
+
+ // Build the CSS.
+ $css = '';
+ foreach ( $this->css_rules as $rule ) {
+ $css .= $rule->get_css( $options['prettify'] );
+ $css .= $options['prettify'] ? "\n" : '';
+ }
+ return $css;
+ }
+
+ /**
+ * Combines selectors from the rules store when they have the same styles.
+ *
+ * @since 6.1.0
+ */
+ private function combine_rules_selectors() {
+ // Build an array of selectors along with the JSON-ified styles to make comparisons easier.
+ $selectors_json = array();
+ foreach ( $this->css_rules as $rule ) {
+ $declarations = $rule->get_declarations()->get_declarations();
+ ksort( $declarations );
+ $selectors_json[ $rule->get_selector() ] = wp_json_encode( $declarations );
+ }
+
+ // Combine selectors that have the same styles.
+ foreach ( $selectors_json as $selector => $json ) {
+ // Get selectors that use the same styles.
+ $duplicates = array_keys( $selectors_json, $json, true );
+ // Skip if there are no duplicates.
+ if ( 1 >= count( $duplicates ) ) {
+ continue;
+ }
+
+ $declarations = $this->css_rules[ $selector ]->get_declarations();
+
+ foreach ( $duplicates as $key ) {
+ // Unset the duplicates from the $selectors_json array to avoid looping through them as well.
+ unset( $selectors_json[ $key ] );
+ // Remove the rules from the rules collection.
+ unset( $this->css_rules[ $key ] );
+ }
+ // Create a new rule with the combined selectors.
+ $duplicate_selectors = implode( ',', $duplicates );
+ $this->css_rules[ $duplicate_selectors ] = new WP_Style_Engine_CSS_Rule( $duplicate_selectors, $declarations );
+ }
+ }
+}
diff --git a/wp-includes/style-engine/class-wp-style-engine.php b/wp-includes/style-engine/class-wp-style-engine.php
new file mode 100644
index 0000000..121bac2
--- /dev/null
+++ b/wp-includes/style-engine/class-wp-style-engine.php
@@ -0,0 +1,691 @@
+<?php
+/**
+ * Style Engine: WP_Style_Engine class
+ *
+ * @package WordPress
+ * @subpackage StyleEngine
+ * @since 6.1.0
+ */
+
+/**
+ * The main class integrating all other WP_Style_Engine_* classes.
+ *
+ * The Style Engine aims to provide a consistent API for rendering styling for blocks
+ * across both client-side and server-side applications.
+ *
+ * This class is final and should not be extended.
+ *
+ * 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.
+ *
+ * @access private
+ * @since 6.1.0
+ * @since 6.3.0 Added support for text-columns.
+ * @since 6.4.0 Added support for background.backgroundImage.
+ */
+#[AllowDynamicProperties]
+final class WP_Style_Engine {
+ /**
+ * Style definitions that contain the instructions to parse/output valid Gutenberg styles from a block's attributes.
+ *
+ * For every style definition, the following properties are valid:
+ *
+ * - 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", ... )`.
+ *
+ * @since 6.1.0
+ * @var array
+ */
+ const BLOCK_STYLE_DEFINITIONS_METADATA = array(
+ 'background' => array(
+ 'backgroundImage' => array(
+ 'property_keys' => array(
+ 'default' => 'background-image',
+ ),
+ 'value_func' => array( self::class, 'get_url_or_value_css_declaration' ),
+ 'path' => array( 'background', 'backgroundImage' ),
+ ),
+ 'backgroundSize' => array(
+ 'property_keys' => array(
+ 'default' => 'background-size',
+ ),
+ 'path' => array( 'background', 'backgroundSize' ),
+ ),
+ ),
+ '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' ),
+ 'css_vars' => array(
+ 'color' => '--wp--preset--color--$slug',
+ ),
+ 'classnames' => array(
+ 'has-background' => true,
+ 'has-$slug-background-color' => 'color',
+ ),
+ ),
+ 'gradient' => array(
+ 'property_keys' => array(
+ 'default' => 'background',
+ ),
+ 'path' => array( 'color', 'gradient' ),
+ 'css_vars' => array(
+ 'gradient' => '--wp--preset--gradient--$slug',
+ ),
+ '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(
+ 'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
+ 'path' => array( 'border', 'top' ),
+ 'css_vars' => array(
+ 'color' => '--wp--preset--color--$slug',
+ ),
+ ),
+ 'right' => array(
+ 'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
+ 'path' => array( 'border', 'right' ),
+ 'css_vars' => array(
+ 'color' => '--wp--preset--color--$slug',
+ ),
+ ),
+ 'bottom' => array(
+ 'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
+ 'path' => array( 'border', 'bottom' ),
+ 'css_vars' => array(
+ 'color' => '--wp--preset--color--$slug',
+ ),
+ ),
+ 'left' => array(
+ 'value_func' => array( self::class, 'get_individual_property_css_declarations' ),
+ 'path' => array( 'border', 'left' ),
+ 'css_vars' => array(
+ 'color' => '--wp--preset--color--$slug',
+ ),
+ ),
+ ),
+ 'shadow' => array(
+ 'shadow' => array(
+ 'property_keys' => array(
+ 'default' => 'box-shadow',
+ ),
+ 'path' => array( 'shadow' ),
+ 'css_vars' => array(
+ 'shadow' => '--wp--preset--shadow--$slug',
+ ),
+ ),
+ ),
+ 'dimensions' => array(
+ 'minHeight' => array(
+ 'property_keys' => array(
+ 'default' => 'min-height',
+ ),
+ 'path' => array( 'dimensions', 'minHeight' ),
+ 'css_vars' => array(
+ 'spacing' => '--wp--preset--spacing--$slug',
+ ),
+ ),
+ ),
+ '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' ),
+ 'classnames' => array(
+ 'has-$slug-font-size' => 'font-size',
+ ),
+ ),
+ 'fontFamily' => array(
+ 'property_keys' => array(
+ 'default' => 'font-family',
+ ),
+ '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' ),
+ ),
+ 'textColumns' => array(
+ 'property_keys' => array(
+ 'default' => 'column-count',
+ ),
+ 'path' => array( 'typography', 'textColumns' ),
+ ),
+ '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' ),
+ ),
+ ),
+ );
+
+ /**
+ * Util: Extracts the slug in kebab case from a preset string,
+ * e.g. `heavenly-blue` from `var:preset|color|heavenlyBlue`.
+ *
+ * @since 6.1.0
+ *
+ * @param string $style_value A single CSS preset value.
+ * @param string $property_key The CSS property that is the second element of the preset string.
+ * Used for matching.
+ * @return string The slug, or empty string if not found.
+ */
+ protected static function get_slug_from_preset_value( $style_value, $property_key ) {
+ if ( is_string( $style_value ) && is_string( $property_key )
+ && str_contains( $style_value, "var:preset|{$property_key}|" )
+ ) {
+ $index_to_splice = strrpos( $style_value, '|' ) + 1;
+ return _wp_to_kebab_case( substr( $style_value, $index_to_splice ) );
+ }
+ return '';
+ }
+
+ /**
+ * Util: Generates a CSS var string, e.g. `var(--wp--preset--color--background)`
+ * from a preset string such as `var:preset|space|50`.
+ *
+ * @since 6.1.0
+ *
+ * @param string $style_value A single CSS preset value.
+ * @param string[] $css_vars An associate array of CSS var patterns
+ * used to generate the var string.
+ * @return string The CSS var, or an empty string if no match for slug found.
+ */
+ protected static function get_css_var_value( $style_value, $css_vars ) {
+ foreach ( $css_vars as $property_key => $css_var_pattern ) {
+ $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
+ *
+ * @param string $store_name A valid store key.
+ * @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" )`.
+ */
+ public static function store_css_rule( $store_name, $css_selector, $css_declarations ) {
+ if ( empty( $store_name ) || empty( $css_selector ) || empty( $css_declarations ) ) {
+ return;
+ }
+ static::get_store( $store_name )->add_rule( $css_selector )->add_declarations( $css_declarations );
+ }
+
+ /**
+ * Returns a store by store key.
+ *
+ * @since 6.1.0
+ *
+ * @param string $store_name A store key.
+ * @return WP_Style_Engine_CSS_Rules_Store|null
+ */
+ 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.
+ *
+ * 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.
+ *
+ * @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.
+ * }
+ * @return array {
+ * @type string[] $classnames Array of class names.
+ * @type string[] $declarations An associative array of CSS definitions,
+ * e.g. `array( "$property" => "$value", "$property" => "$value" )`.
+ * }
+ */
+ 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;
+ }
+
+ /**
+ * Returns classnames, and generates classname(s) from a CSS preset property pattern,
+ * e.g. `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`.
+ *
+ * @since 6.1.0
+ *
+ * @param string $style_value A single raw style value or CSS preset property
+ * from the `$block_styles` array.
+ * @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.
+ */
+ 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;
+ }
+
+ $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
+ *
+ * @param mixed $style_value A single raw style value from $block_styles array.
+ * @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA.
+ * @param array $options {
+ * Optional. An array of options. Default empty array.
+ *
+ * @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.
+ * }
+ * @return string[] An associative array of CSS definitions, e.g. `array( "$property" => "$value", "$property" => "$value" )`.
+ */
+ 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.
+ *
+ * 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};"
+ *
+ * @since 6.1.0
+ *
+ * @param array $style_value A single raw style value from `$block_styles` array.
+ * @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'.
+ * @param array $options {
+ * Optional. An array of options. Default empty array.
+ *
+ * @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.
+ * }
+ * @return string[] An associative array of CSS definitions, e.g. `array( "$property" => "$value", "$property" => "$value" )`.
+ */
+ 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();
+ }
+
+ /*
+ * 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".
+ */
+ $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.
+ if ( is_string( $value ) && str_contains( $value, 'var:' )
+ && ! $should_skip_css_vars && ! empty( $individual_property_definition['css_vars'] )
+ ) {
+ $value = static::get_css_var_value( $value, $individual_property_definition['css_vars'] );
+ }
+
+ $individual_css_property = sprintf( $style_definition['property_keys']['individual'], $individual_property_key );
+
+ $css_declarations[ $individual_css_property ] = $value;
+ }
+ }
+ return $css_declarations;
+ }
+
+ /**
+ * 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;
+ }
+
+ /**
+ * Returns compiled CSS from CSS declarations.
+ *
+ * @since 6.1.0
+ *
+ * @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.
+ * @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
+ *
+ * @param WP_Style_Engine_CSS_Rule[] $css_rules An array of WP_Style_Engine_CSS_Rule objects
+ * from a store or otherwise.
+ * @param array $options {
+ * Optional. An array of options. Default empty array.
+ *
+ * @type string|null $context An identifier describing the origin of the style object,
+ * e.g. 'block-supports' or 'global-styles'. Default 'block-supports'.
+ * When set, the style engine will attempt to store the CSS rules.
+ * @type bool $optimize Whether to optimize the CSS output, e.g. combine rules.
+ * Default false.
+ * @type bool $prettify Whether to add new lines and indents to output.
+ * Defaults to whether the `SCRIPT_DEBUG` constant is defined.
+ * }
+ * @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 );
+ }
+}