vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-09-01 22:50:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Correct and improve inline docs relating to the style engine.

Browse Source 
See #57840


git-svn-id: https://develop.svn.wordpress.org/trunk@55719 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2023-05-03 23:55:50 +00:00
parent a3ed152c54
commit eb248dc65b
6 changed files with 70 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/style-engine/class-wp-style-engine.php
+43 -41
View File
@@ -16,7 +16,7 @@
*
* 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.
* 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
@@ -229,13 +229,12 @@ final class WP_Style_Engine {
);
/**
* Util: Extracts the slug in kebab case from a preset string, e.g., "heavenly-blue" from 'var:preset|color|heavenlyBlue'.
* 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 ) {
@@ -247,17 +246,16 @@ final class WP_Style_Engine {
}
/**
* Util: Generates a CSS var string, e.g., var(--wp--preset--color--background) from a preset string such as `var:preset|space|50`.
* 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.
* @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 ) {
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(
@@ -276,7 +274,6 @@ final class WP_Style_Engine {
* @since 6.1.0
*
* @param string $style_value A single CSS preset value.
*
* @return bool
*/
protected static function is_valid_style_value( $style_value ) {
@@ -290,9 +287,8 @@ final class WP_Style_Engine {
*
* @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" ).
*
* @return void.
* @param string[] $css_declarations An associative array of CSS definitions, e.g., `array( "$property" => "$value", "$property" => "$value" )`.
* @return void
*/
public static function store_css_rule( $store_name, $css_selector, $css_declarations ) {
if ( empty( $store_name ) || empty( $css_selector ) || empty( $css_declarations ) ) {
@@ -307,8 +303,7 @@ final class WP_Style_Engine {
* @since 6.1.0
*
* @param string $store_name A store key.
*
* @return WP_Style_Engine_CSS_Rules_Store
* @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 );
@@ -324,14 +319,13 @@ final class WP_Style_Engine {
* @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 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 Classnames separated by a space.
* @type string[] $declarations An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ).
* @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 ) {
@@ -364,14 +358,13 @@ final class WP_Style_Engine {
}
/**
* Returns classnames, and generates classname(s) from a CSS preset property pattern, e.g., '`var:preset|<PRESET_TYPE>|<PRESET_SLUG>`'.
* 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 array $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 array|string[] An array of CSS classnames, or empty array.
* @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 ) ) {
@@ -407,15 +400,16 @@ final class WP_Style_Engine {
*
* @since 6.1.0
*
* @param array $style_value A single raw style value from $block_styles array.
* @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`.
* @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" ).
* @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'] ) ) {
@@ -473,21 +467,29 @@ final class WP_Style_Engine {
/**
* 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.
* e.g., "$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};"
*
* 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 $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`.
* @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" ).
* @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'] ) ) {
@@ -526,13 +528,12 @@ final class WP_Style_Engine {
}
/**
* Returns compiled CSS from 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_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 ) {
@@ -559,10 +560,11 @@ final class WP_Style_Engine {
* @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 is `false`.
* @type bool $prettify Whether to add new lines and indents to output. Default is the test of whether the global constant `SCRIPT_DEBUG` is defined.
* @type string|null $context An identifier describing the origin of the style object, e.g., 'block-supports' or 'global-styles'. Default is '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 is `false`.
* @type bool $prettify Whether to add new lines and indents to output. Default is the test of whether the global constant `SCRIPT_DEBUG` is defined.
* }
*
* @return string A compiled stylesheet from stored CSS rules.
*/
public static function compile_stylesheet_from_css_rules( $css_rules, $options = array() ) {