| 1 |
<?php |
| 2 |
/** |
| 3 |
* WP_Style_Engine_Gutenberg |
| 4 |
* |
| 5 |
* Generates classnames and block styles. |
| 6 |
* |
| 7 |
* @package gutenberg |
| 8 |
*/ |
| 9 |
|
| 10 |
if ( ! class_exists( 'WP_Style_Engine_Gutenberg' ) ) { |
| 11 |
|
| 12 |
/** |
| 13 |
* Class WP_Style_Engine_Gutenberg. |
| 14 |
* |
| 15 |
* The Style Engine aims to provide a consistent API for rendering styling for blocks across both client-side and server-side applications. |
| 16 |
* |
| 17 |
* This class is for internal Core usage and is not supposed to be used by extenders (plugins and/or themes). |
| 18 |
* This class is final and should not be extended. |
| 19 |
* This is a low-level API that may need to do breaking changes. Please, use wp_style_engine_get_styles instead. |
| 20 |
* |
| 21 |
* @access private |
| 22 |
*/ |
| 23 |
final class WP_Style_Engine_Gutenberg { |
| 24 |
/** |
| 25 |
* Style definitions that contain the instructions to parse/output valid Gutenberg styles from a block's attributes. |
| 26 |
* |
| 27 |
* For every style definition, the following properties are valid: |
| 28 |
* |
| 29 |
* - classnames => (array) an array of classnames to be returned for block styles. The key is a classname or pattern. |
| 30 |
* A value of `true` means the classname should be applied always. Otherwise, a valid CSS property (string) |
| 31 |
* to match the incoming value, e.g., "color" to match var:preset|color|somePresetSlug. |
| 32 |
* - css_vars => (array) an array of key value pairs used to generate CSS var values. |
| 33 |
* The key should be the CSS property name that matches the second element of the preset string value, |
| 34 |
* i.e., "color" in var:preset|color|somePresetSlug. The value is a CSS var pattern (e.g. `--wp--preset--color--$slug`), |
| 35 |
* whose `$slug` fragment will be replaced with the preset slug, which is the third element of the preset string value, |
| 36 |
* i.e., `somePresetSlug` in var:preset|color|somePresetSlug. |
| 37 |
* - property_keys => (array) array of keys whose values represent a valid CSS property, e.g., "margin" or "border". |
| 38 |
* - path => (array) a path that accesses the corresponding style value in the block style object. |
| 39 |
* - 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", ... )`. |
| 40 |
* |
| 41 |
* @var array |
| 42 |
*/ |
| 43 |
const BLOCK_STYLE_DEFINITIONS_METADATA = array( |
| 44 |
'background' => array( |
| 45 |
'backgroundImage' => array( |
| 46 |
'property_keys' => array( |
| 47 |
'default' => 'background-image', |
| 48 |
), |
| 49 |
'value_func' => array( self::class, 'get_url_or_value_css_declaration' ), |
| 50 |
'path' => array( 'background', 'backgroundImage' ), |
| 51 |
), |
| 52 |
'backgroundPosition' => array( |
| 53 |
'property_keys' => array( |
| 54 |
'default' => 'background-position', |
| 55 |
), |
| 56 |
'path' => array( 'background', 'backgroundPosition' ), |
| 57 |
), |
| 58 |
'backgroundRepeat' => array( |
| 59 |
'property_keys' => array( |
| 60 |
'default' => 'background-repeat', |
| 61 |
), |
| 62 |
'path' => array( 'background', 'backgroundRepeat' ), |
| 63 |
), |
| 64 |
'backgroundSize' => array( |
| 65 |
'property_keys' => array( |
| 66 |
'default' => 'background-size', |
| 67 |
), |
| 68 |
'path' => array( 'background', 'backgroundSize' ), |
| 69 |
), |
| 70 |
'backgroundAttachment' => array( |
| 71 |
'property_keys' => array( |
| 72 |
'default' => 'background-attachment', |
| 73 |
), |
| 74 |
'path' => array( 'background', 'backgroundAttachment' ), |
| 75 |
), |
| 76 |
'gradient' => array( |
| 77 |
'property_keys' => array( |
| 78 |
'default' => 'background-image', |
| 79 |
), |
| 80 |
'css_vars' => array( |
| 81 |
'gradient' => '--wp--preset--gradient--$slug', |
| 82 |
), |
| 83 |
'path' => array( 'background', 'gradient' ), |
| 84 |
'classnames' => array( |
| 85 |
'has-background' => true, |
| 86 |
), |
| 87 |
), |
| 88 |
), |
| 89 |
'color' => array( |
| 90 |
'text' => array( |
| 91 |
'property_keys' => array( |
| 92 |
'default' => 'color', |
| 93 |
), |
| 94 |
'path' => array( 'color', 'text' ), |
| 95 |
'css_vars' => array( |
| 96 |
'color' => '--wp--preset--color--$slug', |
| 97 |
), |
| 98 |
'classnames' => array( |
| 99 |
'has-text-color' => true, |
| 100 |
'has-$slug-color' => 'color', |
| 101 |
), |
| 102 |
), |
| 103 |
'background' => array( |
| 104 |
'property_keys' => array( |
| 105 |
'default' => 'background-color', |
| 106 |
), |
| 107 |
'path' => array( 'color', 'background' ), |
| 108 |
'css_vars' => array( |
| 109 |
'color' => '--wp--preset--color--$slug', |
| 110 |
), |
| 111 |
'classnames' => array( |
| 112 |
'has-background' => true, |
| 113 |
'has-$slug-background-color' => 'color', |
| 114 |
), |
| 115 |
), |
| 116 |
'gradient' => array( |
| 117 |
'property_keys' => array( |
| 118 |
'default' => 'background', |
| 119 |
), |
| 120 |
'css_vars' => array( |
| 121 |
'gradient' => '--wp--preset--gradient--$slug', |
| 122 |
), |
| 123 |
'path' => array( 'color', 'gradient' ), |
| 124 |
'classnames' => array( |
| 125 |
'has-background' => true, |
| 126 |
'has-$slug-gradient-background' => 'gradient', |
| 127 |
), |
| 128 |
), |
| 129 |
), |
| 130 |
'border' => array( |
| 131 |
'color' => array( |
| 132 |
'property_keys' => array( |
| 133 |
'default' => 'border-color', |
| 134 |
'individual' => 'border-%s-color', |
| 135 |
), |
| 136 |
'path' => array( 'border', 'color' ), |
| 137 |
'classnames' => array( |
| 138 |
'has-border-color' => true, |
| 139 |
'has-$slug-border-color' => 'color', |
| 140 |
), |
| 141 |
), |
| 142 |
'radius' => array( |
| 143 |
'property_keys' => array( |
| 144 |
'default' => 'border-radius', |
| 145 |
'individual' => 'border-%s-radius', |
| 146 |
), |
| 147 |
'path' => array( 'border', 'radius' ), |
| 148 |
'css_vars' => array( |
| 149 |
'border-radius' => '--wp--preset--border-radius--$slug', |
| 150 |
), |
| 151 |
), |
| 152 |
'style' => array( |
| 153 |
'property_keys' => array( |
| 154 |
'default' => 'border-style', |
| 155 |
'individual' => 'border-%s-style', |
| 156 |
), |
| 157 |
'path' => array( 'border', 'style' ), |
| 158 |
), |
| 159 |
'width' => array( |
| 160 |
'property_keys' => array( |
| 161 |
'default' => 'border-width', |
| 162 |
'individual' => 'border-%s-width', |
| 163 |
), |
| 164 |
'path' => array( 'border', 'width' ), |
| 165 |
), |
| 166 |
'top' => array( |
| 167 |
'value_func' => array( self::class, 'get_individual_property_css_declarations' ), |
| 168 |
'path' => array( 'border', 'top' ), |
| 169 |
'css_vars' => array( |
| 170 |
'color' => '--wp--preset--color--$slug', |
| 171 |
), |
| 172 |
), |
| 173 |
'right' => array( |
| 174 |
'value_func' => array( self::class, 'get_individual_property_css_declarations' ), |
| 175 |
'path' => array( 'border', 'right' ), |
| 176 |
'css_vars' => array( |
| 177 |
'color' => '--wp--preset--color--$slug', |
| 178 |
), |
| 179 |
), |
| 180 |
'bottom' => array( |
| 181 |
'value_func' => array( self::class, 'get_individual_property_css_declarations' ), |
| 182 |
'path' => array( 'border', 'bottom' ), |
| 183 |
'css_vars' => array( |
| 184 |
'color' => '--wp--preset--color--$slug', |
| 185 |
), |
| 186 |
), |
| 187 |
'left' => array( |
| 188 |
'value_func' => array( self::class, 'get_individual_property_css_declarations' ), |
| 189 |
'path' => array( 'border', 'left' ), |
| 190 |
'css_vars' => array( |
| 191 |
'color' => '--wp--preset--color--$slug', |
| 192 |
), |
| 193 |
), |
| 194 |
), |
| 195 |
'shadow' => array( |
| 196 |
'shadow' => array( |
| 197 |
'property_keys' => array( |
| 198 |
'default' => 'box-shadow', |
| 199 |
), |
| 200 |
'path' => array( 'shadow' ), |
| 201 |
'css_vars' => array( |
| 202 |
'shadow' => '--wp--preset--shadow--$slug', |
| 203 |
), |
| 204 |
), |
| 205 |
), |
| 206 |
'dimensions' => array( |
| 207 |
'aspectRatio' => array( |
| 208 |
'property_keys' => array( |
| 209 |
'default' => 'aspect-ratio', |
| 210 |
), |
| 211 |
'path' => array( 'dimensions', 'aspectRatio' ), |
| 212 |
'classnames' => array( |
| 213 |
'has-aspect-ratio' => true, |
| 214 |
), |
| 215 |
), |
| 216 |
'height' => array( |
| 217 |
'property_keys' => array( |
| 218 |
'default' => 'height', |
| 219 |
), |
| 220 |
'path' => array( 'dimensions', 'height' ), |
| 221 |
), |
| 222 |
'minHeight' => array( |
| 223 |
'property_keys' => array( |
| 224 |
'default' => 'min-height', |
| 225 |
), |
| 226 |
'path' => array( 'dimensions', 'minHeight' ), |
| 227 |
'css_vars' => array( |
| 228 |
'dimension' => '--wp--preset--dimension--$slug', |
| 229 |
), |
| 230 |
), |
| 231 |
'minWidth' => array( |
| 232 |
'property_keys' => array( |
| 233 |
'default' => 'min-width', |
| 234 |
), |
| 235 |
'path' => array( 'dimensions', 'minWidth' ), |
| 236 |
'css_vars' => array( |
| 237 |
'dimension' => '--wp--preset--dimension--$slug', |
| 238 |
), |
| 239 |
), |
| 240 |
'width' => array( |
| 241 |
'property_keys' => array( |
| 242 |
'default' => 'width', |
| 243 |
), |
| 244 |
'path' => array( 'dimensions', 'width' ), |
| 245 |
'css_vars' => array( |
| 246 |
'dimension' => '--wp--preset--dimension--$slug', |
| 247 |
), |
| 248 |
), |
| 249 |
), |
| 250 |
'spacing' => array( |
| 251 |
'padding' => array( |
| 252 |
'property_keys' => array( |
| 253 |
'default' => 'padding', |
| 254 |
'individual' => 'padding-%s', |
| 255 |
), |
| 256 |
'path' => array( 'spacing', 'padding' ), |
| 257 |
'css_vars' => array( |
| 258 |
'spacing' => '--wp--preset--spacing--$slug', |
| 259 |
), |
| 260 |
), |
| 261 |
'margin' => array( |
| 262 |
'property_keys' => array( |
| 263 |
'default' => 'margin', |
| 264 |
'individual' => 'margin-%s', |
| 265 |
), |
| 266 |
'path' => array( 'spacing', 'margin' ), |
| 267 |
'css_vars' => array( |
| 268 |
'spacing' => '--wp--preset--spacing--$slug', |
| 269 |
), |
| 270 |
), |
| 271 |
), |
| 272 |
'typography' => array( |
| 273 |
'fontSize' => array( |
| 274 |
'property_keys' => array( |
| 275 |
'default' => 'font-size', |
| 276 |
), |
| 277 |
'css_vars' => array( |
| 278 |
'font-size' => '--wp--preset--font-size--$slug', |
| 279 |
), |
| 280 |
'path' => array( 'typography', 'fontSize' ), |
| 281 |
'classnames' => array( |
| 282 |
'has-$slug-font-size' => 'font-size', |
| 283 |
), |
| 284 |
), |
| 285 |
'fontFamily' => array( |
| 286 |
'property_keys' => array( |
| 287 |
'default' => 'font-family', |
| 288 |
), |
| 289 |
'css_vars' => array( |
| 290 |
'font-family' => '--wp--preset--font-family--$slug', |
| 291 |
), |
| 292 |
'path' => array( 'typography', 'fontFamily' ), |
| 293 |
'classnames' => array( |
| 294 |
'has-$slug-font-family' => 'font-family', |
| 295 |
), |
| 296 |
), |
| 297 |
'fontStyle' => array( |
| 298 |
'property_keys' => array( |
| 299 |
'default' => 'font-style', |
| 300 |
), |
| 301 |
'path' => array( 'typography', 'fontStyle' ), |
| 302 |
), |
| 303 |
'fontWeight' => array( |
| 304 |
'property_keys' => array( |
| 305 |
'default' => 'font-weight', |
| 306 |
), |
| 307 |
'path' => array( 'typography', 'fontWeight' ), |
| 308 |
), |
| 309 |
'lineHeight' => array( |
| 310 |
'property_keys' => array( |
| 311 |
'default' => 'line-height', |
| 312 |
), |
| 313 |
'path' => array( 'typography', 'lineHeight' ), |
| 314 |
), |
| 315 |
'textColumns' => array( |
| 316 |
'property_keys' => array( |
| 317 |
'default' => 'column-count', |
| 318 |
), |
| 319 |
'path' => array( 'typography', 'textColumns' ), |
| 320 |
), |
| 321 |
'textDecoration' => array( |
| 322 |
'property_keys' => array( |
| 323 |
'default' => 'text-decoration', |
| 324 |
), |
| 325 |
'path' => array( 'typography', 'textDecoration' ), |
| 326 |
), |
| 327 |
'textIndent' => array( |
| 328 |
'property_keys' => array( |
| 329 |
'default' => 'text-indent', |
| 330 |
), |
| 331 |
'path' => array( 'typography', 'textIndent' ), |
| 332 |
), |
| 333 |
'textTransform' => array( |
| 334 |
'property_keys' => array( |
| 335 |
'default' => 'text-transform', |
| 336 |
), |
| 337 |
'path' => array( 'typography', 'textTransform' ), |
| 338 |
), |
| 339 |
'letterSpacing' => array( |
| 340 |
'property_keys' => array( |
| 341 |
'default' => 'letter-spacing', |
| 342 |
), |
| 343 |
'path' => array( 'typography', 'letterSpacing' ), |
| 344 |
), |
| 345 |
'writingMode' => array( |
| 346 |
'property_keys' => array( |
| 347 |
'default' => 'writing-mode', |
| 348 |
), |
| 349 |
'path' => array( 'typography', 'writingMode' ), |
| 350 |
), |
| 351 |
), |
| 352 |
); |
| 353 |
|
| 354 |
/** |
| 355 |
* Util: Extracts the slug in kebab case from a preset string, e.g., "heavenly-blue" from 'var:preset|color|heavenlyBlue'. |
| 356 |
* |
| 357 |
* @param string $style_value A single CSS preset value. |
| 358 |
* @param string $property_key The CSS property that is the second element of the preset string. Used for matching. |
| 359 |
* |
| 360 |
* @return string The slug, or empty string if not found. |
| 361 |
*/ |
| 362 |
protected static function get_slug_from_preset_value( $style_value, $property_key ) { |
| 363 |
if ( is_string( $style_value ) && is_string( $property_key ) && str_contains( $style_value, "var:preset|{$property_key}|" ) ) { |
| 364 |
$index_to_splice = strrpos( $style_value, '|' ) + 1; |
| 365 |
return _wp_to_kebab_case( substr( $style_value, $index_to_splice ) ); |
| 366 |
} |
| 367 |
return ''; |
| 368 |
} |
| 369 |
|
| 370 |
/** |
| 371 |
* Util: Generates a CSS var string, e.g., var(--wp--preset--color--background) from a preset string such as `var:preset|space|50`. |
| 372 |
* |
| 373 |
* @param string $style_value A single CSS preset value. |
| 374 |
* @param string[] $css_vars An associate array of CSS var patterns used to generate the var string. |
| 375 |
* |
| 376 |
* @return string The css var, or an empty string if no match for slug found. |
| 377 |
*/ |
| 378 |
protected static function get_css_var_value( $style_value, $css_vars ) { |
| 379 |
foreach ( $css_vars as $property_key => $css_var_pattern ) { |
| 380 |
$slug = static::get_slug_from_preset_value( $style_value, $property_key ); |
| 381 |
if ( static::is_valid_style_value( $slug ) ) { |
| 382 |
$var = strtr( |
| 383 |
$css_var_pattern, |
| 384 |
array( '$slug' => $slug ) |
| 385 |
); |
| 386 |
return "var($var)"; |
| 387 |
} |
| 388 |
} |
| 389 |
return ''; |
| 390 |
} |
| 391 |
|
| 392 |
/** |
| 393 |
* Util: Checks whether an incoming block style value is valid. |
| 394 |
* |
| 395 |
* @param string? $style_value A single css preset value. |
| 396 |
* |
| 397 |
* @return bool |
| 398 |
*/ |
| 399 |
protected static function is_valid_style_value( $style_value ) { |
| 400 |
return '0' === $style_value || ! empty( $style_value ); |
| 401 |
} |
| 402 |
|
| 403 |
/** |
| 404 |
* Stores a CSS rule using the provided CSS selector and CSS declarations. |
| 405 |
* |
| 406 |
* @param string $store_name A valid store key. |
| 407 |
* @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. |
| 408 |
* @param string[] $css_declarations An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ). |
| 409 |
* @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`. |
| 410 |
* |
| 411 |
* @return void. |
| 412 |
*/ |
| 413 |
public static function store_css_rule( $store_name, $css_selector, $css_declarations, $rules_group = '' ) { |
| 414 |
if ( empty( $store_name ) || empty( $css_selector ) || empty( $css_declarations ) ) { |
| 415 |
return; |
| 416 |
} |
| 417 |
static::get_store( $store_name )->add_rule( $css_selector, $rules_group )->add_declarations( $css_declarations ); |
| 418 |
} |
| 419 |
|
| 420 |
/** |
| 421 |
* Returns a store by store key. |
| 422 |
* |
| 423 |
* @param string $store_name A store key. |
| 424 |
* |
| 425 |
* @return WP_Style_Engine_CSS_Rules_Store_Gutenberg |
| 426 |
*/ |
| 427 |
public static function get_store( $store_name ) { |
| 428 |
return WP_Style_Engine_CSS_Rules_Store_Gutenberg::get_store( $store_name ); |
| 429 |
} |
| 430 |
|
| 431 |
/** |
| 432 |
* Returns classnames and CSS based on the values in a styles object. |
| 433 |
* Return values are parsed based on the instructions in BLOCK_STYLE_DEFINITIONS_METADATA. |
| 434 |
* |
| 435 |
* @since 6.1.0 |
| 436 |
* |
| 437 |
* @param array $block_styles The style object. |
| 438 |
* @param array $options { |
| 439 |
* Optional. An array of options. Default empty array. |
| 440 |
* |
| 441 |
* @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`. |
| 442 |
* @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 }`, |
| 443 |
* otherwise, the value will be a concatenated string of CSS declarations. |
| 444 |
* } |
| 445 |
* |
| 446 |
* @return array { |
| 447 |
* @type string $classnames Classnames separated by a space. |
| 448 |
* @type string[] $declarations An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ). |
| 449 |
* } |
| 450 |
*/ |
| 451 |
public static function parse_block_styles( $block_styles, $options ) { |
| 452 |
$parsed_styles = array( |
| 453 |
'classnames' => array(), |
| 454 |
'declarations' => array(), |
| 455 |
); |
| 456 |
if ( empty( $block_styles ) || ! is_array( $block_styles ) ) { |
| 457 |
return $parsed_styles; |
| 458 |
} |
| 459 |
|
| 460 |
// Collect CSS and classnames. |
| 461 |
foreach ( static::BLOCK_STYLE_DEFINITIONS_METADATA as $definition_group_key => $definition_group_style ) { |
| 462 |
if ( empty( $block_styles[ $definition_group_key ] ) ) { |
| 463 |
continue; |
| 464 |
} |
| 465 |
foreach ( $definition_group_style as $style_definition ) { |
| 466 |
$style_value = _wp_array_get( $block_styles, $style_definition['path'], null ); |
| 467 |
|
| 468 |
if ( ! static::is_valid_style_value( $style_value ) ) { |
| 469 |
continue; |
| 470 |
} |
| 471 |
|
| 472 |
$classnames = static::get_classnames( $style_value, $style_definition ); |
| 473 |
if ( ! empty( $classnames ) ) { |
| 474 |
$parsed_styles['classnames'] = array_merge( $parsed_styles['classnames'], $classnames ); |
| 475 |
} |
| 476 |
|
| 477 |
$css_declarations = static::get_css_declarations( $style_value, $style_definition, $options ); |
| 478 |
if ( ! empty( $css_declarations ) ) { |
| 479 |
/* |
| 480 |
* Combine background gradient and background image into a single |
| 481 |
* comma-separated background-image value, matching the JS style engine. |
| 482 |
*/ |
| 483 |
if ( isset( $css_declarations['background-image'] ) && isset( $parsed_styles['declarations']['background-image'] ) ) { |
| 484 |
$css_declarations['background-image'] = $css_declarations['background-image'] . ', ' . $parsed_styles['declarations']['background-image']; |
| 485 |
} |
| 486 |
$parsed_styles['declarations'] = array_merge( $parsed_styles['declarations'], $css_declarations ); |
| 487 |
} |
| 488 |
} |
| 489 |
} |
| 490 |
|
| 491 |
return $parsed_styles; |
| 492 |
} |
| 493 |
|
| 494 |
/** |
| 495 |
* Returns classnames, and generates classname(s) from a CSS preset property pattern, e.g., '`var:preset|<PRESET_TYPE>|<PRESET_SLUG>`'. |
| 496 |
* |
| 497 |
* @param array $style_value A single raw style value or css preset property from the $block_styles array. |
| 498 |
* @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA. |
| 499 |
* |
| 500 |
* @return array|string[] An array of CSS classnames, or empty array. |
| 501 |
*/ |
| 502 |
protected static function get_classnames( $style_value, $style_definition ) { |
| 503 |
if ( empty( $style_value ) ) { |
| 504 |
return array(); |
| 505 |
} |
| 506 |
|
| 507 |
$classnames = array(); |
| 508 |
if ( ! empty( $style_definition['classnames'] ) ) { |
| 509 |
foreach ( $style_definition['classnames'] as $classname => $property_key ) { |
| 510 |
if ( true === $property_key ) { |
| 511 |
$classnames[] = $classname; |
| 512 |
continue; |
| 513 |
} |
| 514 |
|
| 515 |
$slug = static::get_slug_from_preset_value( $style_value, $property_key ); |
| 516 |
|
| 517 |
if ( $slug ) { |
| 518 |
/* |
| 519 |
* Right now we expect a classname pattern to be stored in BLOCK_STYLE_DEFINITIONS_METADATA. |
| 520 |
* One day, if there are no stored schemata, we could allow custom patterns or |
| 521 |
* generate classnames based on other properties |
| 522 |
* such as a path or a value or a prefix passed in options. |
| 523 |
*/ |
| 524 |
$classnames[] = strtr( $classname, array( '$slug' => $slug ) ); |
| 525 |
} |
| 526 |
} |
| 527 |
} |
| 528 |
|
| 529 |
return $classnames; |
| 530 |
} |
| 531 |
|
| 532 |
/** |
| 533 |
* Returns an array of CSS declarations based on valid block style values. |
| 534 |
* |
| 535 |
* @since 6.1.0 |
| 536 |
* |
| 537 |
* @param array $style_value A single raw style value from $block_styles array. |
| 538 |
* @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA. |
| 539 |
* @param array $options { |
| 540 |
* Optional. An array of options. Default empty array. |
| 541 |
* |
| 542 |
* @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`. |
| 543 |
* } |
| 544 |
* |
| 545 |
* @return string[] An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ). |
| 546 |
*/ |
| 547 |
protected static function get_css_declarations( $style_value, $style_definition, $options = array() ) { |
| 548 |
if ( isset( $style_definition['value_func'] ) && is_callable( $style_definition['value_func'] ) ) { |
| 549 |
return call_user_func( $style_definition['value_func'], $style_value, $style_definition, $options ); |
| 550 |
} |
| 551 |
|
| 552 |
$css_declarations = array(); |
| 553 |
$style_property_keys = $style_definition['property_keys']; |
| 554 |
$should_skip_css_vars = isset( $options['convert_vars_to_classnames'] ) && true === $options['convert_vars_to_classnames']; |
| 555 |
|
| 556 |
/* |
| 557 |
* Build CSS var values from `var:preset|<PRESET_TYPE>|<PRESET_SLUG>` values, e.g, `var(--wp--css--rule-slug )`. |
| 558 |
* Check if the value is a CSS preset and there's a corresponding css_var pattern in the style definition. |
| 559 |
*/ |
| 560 |
if ( is_string( $style_value ) && str_contains( $style_value, 'var:' ) ) { |
| 561 |
if ( ! $should_skip_css_vars && ! empty( $style_definition['css_vars'] ) ) { |
| 562 |
$css_var = static::get_css_var_value( $style_value, $style_definition['css_vars'] ); |
| 563 |
if ( static::is_valid_style_value( $css_var ) ) { |
| 564 |
$css_declarations[ $style_property_keys['default'] ] = $css_var; |
| 565 |
} |
| 566 |
} |
| 567 |
return $css_declarations; |
| 568 |
} |
| 569 |
|
| 570 |
/* |
| 571 |
* Default rule builder. |
| 572 |
* If the input contains an array, assume box model-like properties |
| 573 |
* for styles such as margins and padding. |
| 574 |
*/ |
| 575 |
if ( is_array( $style_value ) ) { |
| 576 |
// Bail out early if the `'individual'` property is not defined. |
| 577 |
if ( ! isset( $style_property_keys['individual'] ) ) { |
| 578 |
return $css_declarations; |
| 579 |
} |
| 580 |
|
| 581 |
foreach ( $style_value as $key => $value ) { |
| 582 |
if ( is_string( $value ) && str_contains( $value, 'var:' ) && ! $should_skip_css_vars && ! empty( $style_definition['css_vars'] ) ) { |
| 583 |
$value = static::get_css_var_value( $value, $style_definition['css_vars'] ); |
| 584 |
} |
| 585 |
|
| 586 |
$individual_property = sprintf( $style_property_keys['individual'], _wp_to_kebab_case( $key ) ); |
| 587 |
|
| 588 |
if ( $individual_property && static::is_valid_style_value( $value ) ) { |
| 589 |
$css_declarations[ $individual_property ] = $value; |
| 590 |
} |
| 591 |
} |
| 592 |
|
| 593 |
return $css_declarations; |
| 594 |
} |
| 595 |
|
| 596 |
$css_declarations[ $style_property_keys['default'] ] = $style_value; |
| 597 |
return $css_declarations; |
| 598 |
} |
| 599 |
|
| 600 |
/** |
| 601 |
* Style value parser that returns a CSS definition array comprising style properties |
| 602 |
* that have keys representing individual style properties, otherwise known as longhand CSS properties. |
| 603 |
* e.g., "$style_property-$individual_feature: $value;", which could represent the following: |
| 604 |
* "border-{top|right|bottom|left}-{color|width|style}: {value};" or, |
| 605 |
* "border-image-{outset|source|width|repeat|slice}: {value};" |
| 606 |
* |
| 607 |
* @param array $style_value A single raw style value from $block_styles array. |
| 608 |
* @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'. |
| 609 |
* @param array $options { |
| 610 |
* Optional. An array of options. Default empty array. |
| 611 |
* |
| 612 |
* @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`. |
| 613 |
* } |
| 614 |
* |
| 615 |
* @return string[] An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ). |
| 616 |
*/ |
| 617 |
protected static function get_individual_property_css_declarations( $style_value, $individual_property_definition, $options = array() ) { |
| 618 |
if ( ! is_array( $style_value ) || empty( $style_value ) || empty( $individual_property_definition['path'] ) ) { |
| 619 |
return array(); |
| 620 |
} |
| 621 |
|
| 622 |
/* |
| 623 |
* The first item in $individual_property_definition['path'] array tells us the style property, e.g., "border". |
| 624 |
* We use this to get a corresponding CSS style definition such as "color" or "width" from the same group. |
| 625 |
* The second item in $individual_property_definition['path'] array refers to the individual property marker, e.g., "top". |
| 626 |
*/ |
| 627 |
$definition_group_key = $individual_property_definition['path'][0]; |
| 628 |
$individual_property_key = $individual_property_definition['path'][1]; |
| 629 |
$should_skip_css_vars = isset( $options['convert_vars_to_classnames'] ) && true === $options['convert_vars_to_classnames']; |
| 630 |
$css_declarations = array(); |
| 631 |
|
| 632 |
foreach ( $style_value as $css_property => $value ) { |
| 633 |
if ( empty( $value ) ) { |
| 634 |
continue; |
| 635 |
} |
| 636 |
|
| 637 |
// Build a path to the individual rules in definitions. |
| 638 |
$style_definition_path = array( $definition_group_key, $css_property ); |
| 639 |
$style_definition = _wp_array_get( static::BLOCK_STYLE_DEFINITIONS_METADATA, $style_definition_path, null ); |
| 640 |
|
| 641 |
if ( $style_definition && isset( $style_definition['property_keys']['individual'] ) ) { |
| 642 |
// Set a CSS var if there is a valid preset value. |
| 643 |
if ( is_string( $value ) && str_contains( $value, 'var:' ) && ! $should_skip_css_vars && ! empty( $individual_property_definition['css_vars'] ) ) { |
| 644 |
$value = static::get_css_var_value( $value, $individual_property_definition['css_vars'] ); |
| 645 |
} |
| 646 |
$individual_css_property = sprintf( $style_definition['property_keys']['individual'], $individual_property_key ); |
| 647 |
$css_declarations[ $individual_css_property ] = $value; |
| 648 |
} |
| 649 |
} |
| 650 |
return $css_declarations; |
| 651 |
} |
| 652 |
|
| 653 |
/** |
| 654 |
* Style value parser that constructs a CSS definition array comprising a single CSS property and value. |
| 655 |
* If the provided value is an array containing a `url` property, the function will return a CSS definition array |
| 656 |
* with a single property and value, with `url` escaped and injected into a CSS `url()` function, |
| 657 |
* e.g., array( 'background-image' => "url( '...' )" ). |
| 658 |
* |
| 659 |
* @param array $style_value A single raw style value from $block_styles array. |
| 660 |
* @param array $style_definition A single style definition from BLOCK_STYLE_DEFINITIONS_METADATA. |
| 661 |
* |
| 662 |
* @return string[] An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ). |
| 663 |
*/ |
| 664 |
protected static function get_url_or_value_css_declaration( $style_value, $style_definition ) { |
| 665 |
if ( empty( $style_value ) ) { |
| 666 |
return array(); |
| 667 |
} |
| 668 |
|
| 669 |
$css_declarations = array(); |
| 670 |
|
| 671 |
if ( isset( $style_definition['property_keys']['default'] ) ) { |
| 672 |
$value = null; |
| 673 |
|
| 674 |
if ( ! empty( $style_value['url'] ) ) { |
| 675 |
$value = "url('" . $style_value['url'] . "')"; |
| 676 |
} elseif ( is_string( $style_value ) ) { |
| 677 |
$value = $style_value; |
| 678 |
} |
| 679 |
|
| 680 |
if ( null !== $value ) { |
| 681 |
$css_declarations[ $style_definition['property_keys']['default'] ] = $value; |
| 682 |
} |
| 683 |
} |
| 684 |
|
| 685 |
return $css_declarations; |
| 686 |
} |
| 687 |
|
| 688 |
/** |
| 689 |
* Returns compiled CSS from css_declarations. |
| 690 |
* |
| 691 |
* @param string[] $css_declarations An associative array of CSS definitions, e.g., array( "$property" => "$value", "$property" => "$value" ). |
| 692 |
* @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. |
| 693 |
* |
| 694 |
* @return string A compiled CSS string. |
| 695 |
*/ |
| 696 |
public static function compile_css( $css_declarations, $css_selector ) { |
| 697 |
if ( empty( $css_declarations ) || ! is_array( $css_declarations ) ) { |
| 698 |
return ''; |
| 699 |
} |
| 700 |
|
| 701 |
// Return an entire rule if there is a selector. |
| 702 |
if ( $css_selector ) { |
| 703 |
$css_rule = new WP_Style_Engine_CSS_Rule_Gutenberg( $css_selector, $css_declarations ); |
| 704 |
return $css_rule->get_css(); |
| 705 |
} |
| 706 |
|
| 707 |
$css_declarations = new WP_Style_Engine_CSS_Declarations_Gutenberg( $css_declarations ); |
| 708 |
return $css_declarations->get_declarations_string(); |
| 709 |
} |
| 710 |
|
| 711 |
/** |
| 712 |
* Returns a compiled stylesheet from stored CSS rules. |
| 713 |
* |
| 714 |
* @param WP_Style_Engine_CSS_Rule_Gutenberg[] $css_rules An array of WP_Style_Engine_CSS_Rule_Gutenberg objects from a store or otherwise. |
| 715 |
* @param array $options { |
| 716 |
* Optional. An array of options. Default empty array. |
| 717 |
* |
| 718 |
* @type bool $optimize Whether to optimize the CSS output, e.g., combine rules. Default is `false`. |
| 719 |
* @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. |
| 720 |
* } |
| 721 |
* |
| 722 |
* @return string A compiled stylesheet from stored CSS rules. |
| 723 |
*/ |
| 724 |
public static function compile_stylesheet_from_css_rules( $css_rules, $options = array() ) { |
| 725 |
$processor = new WP_Style_Engine_Processor_Gutenberg(); |
| 726 |
$processor->add_rules( $css_rules ); |
| 727 |
return $processor->get_css( $options ); |
| 728 |
} |
| 729 |
} |
| 730 |
} |
| 731 |
|
