wp_style_engine_get_styles( array $block_styles, array $options = array() ): array

Description

Parameters

$block_stylesarray

The style object.

$optionsarrayoptional

An array of options. Default empty array.Default: array()

• $contextstring|null

  An identifier describing the origin of the style object, e.g. 'block-supports' or 'global-styles'. Default null. When set, the style engine will attempt to store the CSS rules, where a selector is also passed.

• $convert_vars_to_classnamesbooldefault: false

  Whether to skip converting incoming CSS var patterns, e.g. var:preset|<PRESET_TYPE>|<PRESET_SLUG>, to var( --wp--preset--* ) values.

• $selectorstring

  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 $css A CSS ruleset or declarations block formatted to be placed in an HTML style attribute or tag.

• $declarationsstring[]

  An associative array of CSS definitions, e.g. array( "$property" => "$value", "$property" => "$value" ).

• $classnamesstring

  Classnames separated by a space.

Uses · 4

• wp_parse_args()Merges user defined arguments into defaults array.
• WP_Style_Engine::parse_block_styles()Returns classnames and CSS based on the values in a styles object.
• WP_Style_Engine::compile_css()Returns compiled CSS from CSS declarations.
• WP_Style_Engine::store_css_rule()Stores a CSS rule using the provided CSS selector and CSS declarations.

Used by · 16

• WP_Theme_JSON::compute_style_properties()Given a styles array, it extracts the style properties and adds them to the $declarations array following the format:
• get_block_core_avatar_border_attributes()Generates class names and styles to apply the border support styles for the Avatar block.
• get_block_core_post_featured_image_border_attributes()Generates class names and styles to apply the border support styles for the Post Featured Image block.
• render_block_core_calendar()Renders the `core/calendar` block on server.
• render_block_core_icon()Renders the `core/icon` block on server.
• render_block_core_post_featured_image()Renders the `core/post-featured-image` block on the server.
• wp_apply_border_support()Adds CSS classes and inline styles for border styles to the incoming attributes array. This will be applied to the block markup in the front-end.
• wp_apply_colors_support()Adds CSS classes and inline styles for colors to the incoming attributes array.
• wp_apply_dimensions_support()Adds CSS classes for block dimensions to the incoming attributes array.
• wp_apply_shadow_support()Add CSS classes and inline styles for shadow features to the incoming attributes array.
• wp_apply_spacing_support()Adds CSS classes for block spacing to the incoming attributes array.
• wp_apply_typography_support()Adds CSS classes and inline styles for typography features such as font sizes to the incoming attributes array. This will be applied to the block markup in the front-end.

Source

View on Trac ↗View on GitHub ↗

63function wp_style_engine_get_styles( $block_styles, $options = array() ) {64	$options = wp_parse_args(65		$options,66		array(67			'selector'                   => null,68			'context'                    => null,69			'convert_vars_to_classnames' => false,70		)71	);72 73	$parsed_styles = WP_Style_Engine::parse_block_styles( $block_styles, $options );74 75	// Output.76	$styles_output = array();77 78	if ( ! empty( $parsed_styles['declarations'] ) ) {79		$styles_output['css']          = WP_Style_Engine::compile_css( $parsed_styles['declarations'], $options['selector'] );80		$styles_output['declarations'] = $parsed_styles['declarations'];81		if ( ! empty( $options['context'] ) ) {82			WP_Style_Engine::store_css_rule( $options['context'], $options['selector'], $parsed_styles['declarations'] );83		}84	}85 86	if ( ! empty( $parsed_styles['classnames'] ) ) {87		$styles_output['classnames'] = implode( ' ', array_unique( $parsed_styles['classnames'] ) );88	}89 90	return array_filter( $styles_output );91}

History

Introduced in 6.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/style-engine.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.