PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of class-wp-style-engine.php

Functions that are not part of a class:

get_slug_from_preset_value( $style_value, $property_key ) X-Ref

Util: Extracts the slug in kebab case from a preset string,
e.g. `heavenly-blue` from `var:preset|color|heavenlyBlue`.

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.
return: string The slug, or empty string if not found.

get_css_var_value( $style_value, $css_vars ) X-Ref

Util: Generates a CSS var string, e.g. `var(--wp--preset--color--background)`
from a preset string such as `var:preset|space|50`.

param: string $style_value A single CSS preset value.
param: string[] $css_vars An associate array of CSS var patterns
return: string The CSS var, or an empty string if no match for slug found.

is_valid_style_value( $style_value ) X-Ref

Util: Checks whether an incoming block style value is valid.

param: string $style_value A single CSS preset value.
return: bool

store_css_rule( $store_name, $css_selector, $css_declarations, $rules_group = '' ) X-Ref

Stores a CSS rule using the provided CSS selector and CSS declarations.

param: string   $store_name       A valid store key.
param: string   $css_selector     When a selector is passed, the function will return
param: string[] $css_declarations An associative array of CSS definitions,
param: string $rules_group        Optional. A parent CSS selector in the case of nested CSS, or a CSS nested @rule,

get_store( $store_name ) X-Ref

Returns a store by store key.

param: string $store_name A store key.
return: WP_Style_Engine_CSS_Rules_Store|null

parse_block_styles( $block_styles, $options ) X-Ref

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.

param: array $block_styles The style object.
param: array $options {
return: array {

get_classnames( $style_value, $style_definition ) X-Ref

Returns classnames, and generates classname(s) from a CSS preset property pattern,
e.g. `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`.

param: string $style_value A single raw style value or CSS preset property
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.

get_css_declarations( $style_value, $style_definition, $options = array() X-Ref

Returns an array of CSS declarations based on valid block style values.

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 {
return: string[] An associative array of CSS definitions, e.g. `array( "$property" => "$value", "$property" => "$value" )`.

get_individual_property_css_declarations( $style_value, $individual_property_definition, $options = array() X-Ref

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};"

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
param: array $options {
return: string[] An associative array of CSS definitions, e.g. `array( "$property" => "$value", "$property" => "$value" )`.

get_url_or_value_css_declaration( $style_value, $style_definition ) X-Ref

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( '...' )" ).

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" ).

compile_css( $css_declarations, $css_selector ) X-Ref

Returns compiled CSS from CSS declarations.

param: string[] $css_declarations An associative array of CSS definitions,
param: string $css_selector When a selector is passed, the function will return
return: string A compiled CSS string.

compile_stylesheet_from_css_rules( $css_rules, $options = array() X-Ref

Returns a compiled stylesheet from stored CSS rules.

param: WP_Style_Engine_CSS_Rule[] $css_rules An array of WP_Style_Engine_CSS_Rule objects
param: array $options {
return: string A compiled stylesheet from stored CSS rules.

File Size:	744 lines (28 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of WordPress Trunk (Updated Daily)

/wp-includes/style-engine/ -> class-wp-style-engine.php (summary)

Defines 12 functions