wp_get_layout_style( string $selector, array $layout, bool $has_block_gap_support = false, string|string[]|null $gap_value = null, bool $should_skip_gap_serialization = false, string|array $fallback_gap_value = '0.5em', array|null $block_spacing = null, array $options = array() ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$selectorstring

CSS selector.

$layoutarray

Layout object. The one that is passed has already checked the existence of default block layout.

$has_block_gap_supportbooloptional

Whether the theme has support for the block gap. Default false.Default: false

$gap_valuestring|string[]|nulloptional

The block gap value to apply. Default null.Default: null

$should_skip_gap_serializationbooloptional

Whether to skip applying the user-defined value set in the editor. Default false.Default: false

$fallback_gap_valuestring|arrayoptional

The block gap value to apply. If it's an array expected properties are "top" and/or "left". Default '0.5em'.Default: '0.5em'

$block_spacingarray|nulloptional

Custom spacing set on the block. Default null.Default: null

$optionsarrayoptional

Extra options for internal callers. Default empty array.Default: array()

• $viewport_overridesarray

  An array of layout property overrides for the sake of style generation, keyed by property name.

• $rules_groupstring|nulldefault: null

  Optional group name for the rules.

• $has_block_gap_overridebooldefault: false

  Whether the block gap has been overridden.

Return value

string

CSS styles on success. Else, empty string.

Performance profile

How much work a call to wp_get_layout_style() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

4

Executed per call on PHP 8.5. The body compiles to 743.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below wp_get_layout_style()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_layout_style() can have, taken from its control-flow graph on PHP 8.5.

Uses · 5

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• _wp_to_kebab_case()This function is trying to replicate what lodash's kebabCase (JS library) does in the client.
• safecss_filter_attr()Filters an inline style attribute and removes disallowed rules.
• wp_style_engine_get_styles()Global public interface method to generate styles from a single style object, e.g. the value of a block's attributes.style object or the top level styles in theme.json.
• wp_style_engine_get_stylesheet_from_css_rules()Returns compiled CSS from a collection of selectors and declarations.

Used by · 1

• wp_render_layout_support_flag()Renders the layout config to the block wrapper.

Source code

View on Trac ↗View on GitHub ↗

499function wp_get_layout_style( $selector, $layout, $has_block_gap_support = false, $gap_value = null, $should_skip_gap_serialization = false, $fallback_gap_value = '0.5em', $block_spacing = null, $options = array() ) {500	$base_layout             = is_array( $layout ) ? $layout : array();501	$viewport_overrides      = $options['viewport_overrides'] ?? null;502	$layout_for_styles       = null === $viewport_overrides ? $base_layout : array_replace( $base_layout, $viewport_overrides );503	$layout_type             = $base_layout['type'] ?? 'default';504	$rules_group             = $options['rules_group'] ?? null;505	$has_block_gap_override  = ! empty( $options['has_block_gap_override'] );506	$should_output_block_gap = null === $viewport_overrides || $has_block_gap_override;507 508	/*509	 * Viewport styles only store changed fields. If a field is present with null,510	 * the user cleared a value inherited from the default viewport, so check511	 * whether the key exists rather than whether the value is truthy.512	 */513	$has_viewport_property_override = static function ( $property ) use ( $viewport_overrides ) {514		return array_key_exists( $property, $viewport_overrides );515	};516	$layout_styles                  = array();517 518	if ( 'default' === $layout_type ) {519		if ( $has_block_gap_support && $should_output_block_gap ) {520			if ( is_array( $gap_value ) ) {521				$gap_value = $gap_value['top'] ?? null;522			}523			if ( null !== $gap_value && ! $should_skip_gap_serialization ) {524				// Get spacing CSS variable from preset value if provided.525				if ( is_string( $gap_value ) && str_contains( $gap_value, 'var:preset|spacing|' ) ) {526					$index_to_splice = strrpos( $gap_value, '|' ) + 1;527					$slug            = _wp_to_kebab_case( substr( $gap_value, $index_to_splice ) );528					$gap_value       = "var(--wp--preset--spacing--$slug)";529				}530 531				array_push(532					$layout_styles,533					array(534						'selector'     => "$selector > *",535						'declarations' => array(536							'margin-block-start' => '0',537							'margin-block-end'   => '0',538						),539					),540					array(541						'selector'     => "$selector > * + *",542						'declarations' => array(543							'margin-block-start' => $gap_value,544							'margin-block-end'   => '0',545						),546					)547				);548			}549		}550	} elseif ( 'constrained' === $layout_type ) {551		$content_size    = $layout_for_styles['contentSize'] ?? '';552		$wide_size       = $layout_for_styles['wideSize'] ?? '';553		$justify_content = $layout_for_styles['justifyContent'] ?? 'center';554 555		// Check if viewport-specific ("override") values exist. Null values are valid and mean the user cleared a value inherited from the default viewport.556		$has_justify_content_override = null !== $viewport_overrides && $has_viewport_property_override( 'justifyContent' );557		$has_content_size_override    = null !== $viewport_overrides && $has_viewport_property_override( 'contentSize' );558		$has_wide_size_override       = null !== $viewport_overrides && $has_viewport_property_override( 'wideSize' );559 560		/*561		 * Styles should be output either if there are no viewport overrides (this is the default case), or if the user has set a new viewport-specific562		 * value for contentSize or wideSize. If a viewport clears a custom constrained size, reset to the global layout variable.563		 */564		$should_output_constrained_sizes = null === $viewport_overrides || $has_content_size_override || $has_wide_size_override;565		$is_resetting_constrained_sizes  = null !== $viewport_overrides &&566			(567				( $has_content_size_override && ! $content_size ) ||568				( $has_wide_size_override && ! $wide_size )569			);570 571		// If a viewport clears a custom constrained size, reset to the global layout variable.572		$all_max_width_value  = $content_size573			? $content_size574			: ( $wide_size && ! $has_content_size_override ? $wide_size : 'var(--wp--style--global--content-size, none)' );575		$wide_max_width_value = $wide_size576			? $wide_size577			: ( $content_size && ! $has_wide_size_override ? $content_size : 'var(--wp--style--global--wide-size, none)' );578

Changelog

Introduced in 5.9.0. 2 changes between 6.7.7 and 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.1.0 tag, from src/wp-includes/block-supports/layout.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.