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 ): string

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

Return

string

CSS styles on success. Else, empty string.

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

View on Trac ↗View on GitHub ↗

271function 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 ) {272	$layout_type   = $layout['type'] ?? 'default';273	$layout_styles = array();274 275	if ( 'default' === $layout_type ) {276		if ( $has_block_gap_support ) {277			if ( is_array( $gap_value ) ) {278				$gap_value = $gap_value['top'] ?? null;279			}280			if ( null !== $gap_value && ! $should_skip_gap_serialization ) {281				// Get spacing CSS variable from preset value if provided.282				if ( is_string( $gap_value ) && str_contains( $gap_value, 'var:preset|spacing|' ) ) {283					$index_to_splice = strrpos( $gap_value, '|' ) + 1;284					$slug            = _wp_to_kebab_case( substr( $gap_value, $index_to_splice ) );285					$gap_value       = "var(--wp--preset--spacing--$slug)";286				}287 288				array_push(289					$layout_styles,290					array(291						'selector'     => "$selector > *",292						'declarations' => array(293							'margin-block-start' => '0',294							'margin-block-end'   => '0',295						),296					),297					array(298						'selector'     => "$selector > * + *",299						'declarations' => array(300							'margin-block-start' => $gap_value,301							'margin-block-end'   => '0',302						),303					)304				);305			}306		}307	} elseif ( 'constrained' === $layout_type ) {308		$content_size    = $layout['contentSize'] ?? '';309		$wide_size       = $layout['wideSize'] ?? '';310		$justify_content = $layout['justifyContent'] ?? 'center';311 312		$all_max_width_value  = $content_size ? $content_size : $wide_size;313		$wide_max_width_value = $wide_size ? $wide_size : $content_size;314 315		// Make sure there is a single CSS rule, and all tags are stripped for security.316		$all_max_width_value  = safecss_filter_attr( explode( ';', $all_max_width_value )[0] );317		$wide_max_width_value = safecss_filter_attr( explode( ';', $wide_max_width_value )[0] );318 319		$margin_left  = 'left' === $justify_content ? '0 !important' : 'auto !important';320		$margin_right = 'right' === $justify_content ? '0 !important' : 'auto !important';321 322		if ( $content_size || $wide_size ) {323			array_push(324				$layout_styles,325				array(326					'selector'     => "$selector > :where(:not(.alignleft):not(.alignright):not(.alignfull))",327					'declarations' => array(328						'max-width'    => $all_max_width_value,329						'margin-left'  => $margin_left,330						'margin-right' => $margin_right,331					),332				),333				array(334					'selector'     => "$selector > .alignwide",335					'declarations' => array( 'max-width' => $wide_max_width_value ),336				),337				array(338					'selector'     => "$selector .alignfull",339					'declarations' => array( 'max-width' => 'none' ),340				)341			);342		}343 344		if ( isset( $block_spacing ) ) {345			$block_spacing_values = wp_style_engine_get_styles(346				array(347					'spacing' => $block_spacing,348				)349			);350

History

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.0.4 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.