wp_get_child_layout_style_rules( string $selector, array $child_layout, array $parent_layout = array(), array|null $viewport_overrides = null ): array

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$selectorstring

CSS selector.

$child_layoutarray

Child layout values.

$parent_layoutarrayoptional

Parent layout values.Default: array()

$viewport_overridesarray|nulloptional

Child viewport layout overrides to emit.Default: null

Return value

array

Child layout style rules.

Performance profile

How much work a call to wp_get_child_layout_style_rules() 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 248.

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 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_child_layout_style_rules() can have, taken from its control-flow graph on PHP 8.5.

Used by · 1

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

Source code

View on Trac ↗View on GitHub ↗

109function wp_get_child_layout_style_rules( $selector, $child_layout, $parent_layout = array(), $viewport_overrides = null ) {110	$base_child_layout              = is_array( $child_layout ) ? $child_layout : array();111	$viewport_overrides             = is_array( $viewport_overrides ) ? $viewport_overrides : null;112	$child_layout                   = null === $viewport_overrides ? $base_child_layout : array_replace( $base_child_layout, $viewport_overrides );113	$child_layout_declarations      = array();114	$child_layout_styles            = array();115	$has_viewport_property_override = static function ( $property ) use ( $viewport_overrides ) {116		return array_key_exists( $property, $viewport_overrides );117	};118 119	$self_stretch      = $child_layout['selfStretch'] ?? null;120	$base_self_stretch = $base_child_layout['selfStretch'] ?? null;121 122	/*123	 * These are the serialized `selfStretch` values. `max` used to be called124	 * "Fixed" in the UI, but was renamed and replaced by `fixedNoShrink`.125	 */126	$flex_child_layout_values = array(127		'fit'   => 'fit',128		'grow'  => 'fill',129		'max'   => 'fixed',130		'fixed' => 'fixedNoShrink',131	);132	$flex_size_values         = array(133		$flex_child_layout_values['max'],134		$flex_child_layout_values['fixed'],135	);136 137	if ( null === $viewport_overrides || $has_viewport_property_override( 'selfStretch' ) || $has_viewport_property_override( 'flexSize' ) ) {138		if (139			null !== $viewport_overrides &&140			( $flex_child_layout_values['fit'] === $self_stretch || $flex_child_layout_values['grow'] === $self_stretch ) &&141			in_array( $base_self_stretch, $flex_size_values, true ) &&142			isset( $base_child_layout['flexSize'] )143		) {144			$child_layout_declarations['flex-basis'] = 'unset';145			if ( $flex_child_layout_values['fixed'] === $base_self_stretch ) {146				$child_layout_declarations['flex-shrink'] = 'unset';147			}148		}149		if ( in_array( $self_stretch, $flex_size_values, true ) && isset( $child_layout['flexSize'] ) ) {150			$child_layout_declarations['flex-basis'] = $child_layout['flexSize'];151			if ( $flex_child_layout_values['fixed'] === $self_stretch ) {152				$child_layout_declarations['flex-shrink'] = '0';153			} elseif ( null !== $viewport_overrides && $flex_child_layout_values['fixed'] === $base_self_stretch ) {154				$child_layout_declarations['flex-shrink'] = 'unset';155			}156			$child_layout_declarations['box-sizing'] = 'border-box';157		} elseif ( $flex_child_layout_values['grow'] === $self_stretch ) {158			$child_layout_declarations['flex-grow'] = '1';159		}160	}161 162	$column_start = $child_layout['columnStart'] ?? null;163	$column_span  = $child_layout['columnSpan'] ?? null;164	if ( null === $viewport_overrides || $has_viewport_property_override( 'columnStart' ) || $has_viewport_property_override( 'columnSpan' ) ) {165		if ( $column_start && $column_span ) {166			$child_layout_declarations['grid-column'] = "$column_start / span $column_span";167		} elseif ( $column_start ) {168			$child_layout_declarations['grid-column'] = "$column_start";169		} elseif ( $column_span ) {170			$child_layout_declarations['grid-column'] = "span $column_span";171		}172	}173 174	$row_start = $child_layout['rowStart'] ?? null;175	$row_span  = $child_layout['rowSpan'] ?? null;176	if ( null === $viewport_overrides || $has_viewport_property_override( 'rowStart' ) || $has_viewport_property_override( 'rowSpan' ) ) {177		if ( $row_start && $row_span ) {178			$child_layout_declarations['grid-row'] = "$row_start / span $row_span";179		} elseif ( $row_start ) {180			$child_layout_declarations['grid-row'] = "$row_start";181		} elseif ( $row_span ) {182			$child_layout_declarations['grid-row'] = "span $row_span";183		}184	}185 186	if ( ! empty( $child_layout_declarations ) ) {187		$child_layout_styles[] = array(188			'selector'     => $selector,

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

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.