wp_render_layout_support_flag( string $block_content, array $block ): string

Compatibility

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

Parameters

$block_contentstring

Rendered block content.

$blockarray

Block object.

Return value

string

Filtered block content.

Performance profile

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

Moderate

Only touches the object cache, via wp_cache_get().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

128–209

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 473.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• cacheobject cachewp_cache_get()one call below wp_render_layout_support_flag()
• hookthird-party callbacksapply_filters()one call below wp_render_layout_support_flag()

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

What one call costs · 12 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 13

• block_has_support()Checks whether the current block type supports the feature requested.
• wp_unique_prefixed_id()Generates an incremental ID that is independent per each different prefix.
• wp_style_engine_get_stylesheet_from_css_rules()Returns compiled CSS from a collection of selectors and declarations.
• wp_get_global_settings()Gets the settings resulting of merging core, theme, and user data.
• wp_get_layout_definitions()Returns layout definitions, keyed by layout type.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• current_theme_supports()Checks a theme's support for a given feature.
• wp_should_skip_block_supports_serialization()Checks whether serialization of the current block's supported properties should occur.
• wp_get_layout_style()Generates the CSS corresponding to the provided layout.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• WP_Block_Type_Registry::get_instance()::get_registered()
• WP_Block_Type_Registry::get_instance()Utility method to retrieve the main instance of the class.

Source code

View on Trac ↗View on GitHub ↗

570function wp_render_layout_support_flag( $block_content, $block ) {571	$block_type            = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );572	$block_supports_layout = block_has_support( $block_type, 'layout', false ) || block_has_support( $block_type, '__experimentalLayout', false );573	$child_layout          = isset( $block['attrs']['style']['layout'] ) ? $block['attrs']['style']['layout'] : null;574 575	if ( ! $block_supports_layout && ! $child_layout ) {576		return $block_content;577	}578 579	$outer_class_names = array();580 581	// Child layout specific logic.582	if ( $child_layout ) {583		$container_content_class   = wp_unique_prefixed_id( 'wp-container-content-' );584		$child_layout_declarations = array();585		$child_layout_styles       = array();586 587		$self_stretch = isset( $child_layout['selfStretch'] ) ? $child_layout['selfStretch'] : null;588 589		if ( 'fixed' === $self_stretch && isset( $child_layout['flexSize'] ) ) {590			$child_layout_declarations['flex-basis'] = $child_layout['flexSize'];591			$child_layout_declarations['box-sizing'] = 'border-box';592		} elseif ( 'fill' === $self_stretch ) {593			$child_layout_declarations['flex-grow'] = '1';594		}595 596		if ( isset( $child_layout['columnSpan'] ) ) {597			$column_span                              = $child_layout['columnSpan'];598			$child_layout_declarations['grid-column'] = "span $column_span";599		}600		if ( isset( $child_layout['rowSpan'] ) ) {601			$row_span                              = $child_layout['rowSpan'];602			$child_layout_declarations['grid-row'] = "span $row_span";603		}604		$child_layout_styles[] = array(605			'selector'     => ".$container_content_class",606			'declarations' => $child_layout_declarations,607		);608 609		/*610		 * If columnSpan is set, and the parent grid is responsive, i.e. if it has a minimumColumnWidth set,611		 * the columnSpan should be removed on small grids. If there's a minimumColumnWidth, the grid is responsive.612		 * But if the minimumColumnWidth value wasn't changed, it won't be set. In that case, if columnCount doesn't613		 * exist, we can assume that the grid is responsive.614		 */615		if ( isset( $child_layout['columnSpan'] ) && ( isset( $block['parentLayout']['minimumColumnWidth'] ) || ! isset( $block['parentLayout']['columnCount'] ) ) ) {616			$column_span_number  = floatval( $child_layout['columnSpan'] );617			$parent_column_width = isset( $block['parentLayout']['minimumColumnWidth'] ) ? $block['parentLayout']['minimumColumnWidth'] : '12rem';618			$parent_column_value = floatval( $parent_column_width );619			$parent_column_unit  = explode( $parent_column_value, $parent_column_width );620 621			/*622			 * If there is no unit, the width has somehow been mangled so we reset both unit and value623			 * to defaults.624			 * Additionally, the unit should be one of px, rem or em, so that also needs to be checked.625			 */626			if ( count( $parent_column_unit ) <= 1 ) {627				$parent_column_unit  = 'rem';628				$parent_column_value = 12;629			} else {630				$parent_column_unit = $parent_column_unit[1];631 632				if ( ! in_array( $parent_column_unit, array( 'px', 'rem', 'em' ), true ) ) {633					$parent_column_unit = 'rem';634				}635			}636 637			/*638			 * A default gap value is used for this computation because custom gap values may not be639			 * viable to use in the computation of the container query value.640			 */641			$default_gap_value     = 'px' === $parent_column_unit ? 24 : 1.5;642			$container_query_value = $column_span_number * $parent_column_value + ( $column_span_number - 1 ) * $default_gap_value;643			$container_query_value = $container_query_value . $parent_column_unit;644 645			$child_layout_styles[] = array(646				'rules_group'  => "@container (max-width: $container_query_value )",647				'selector'     => ".$container_content_class",648				'declarations' => array(649					'grid-column' => '1/-1',

Changelog

Introduced in 5.8.0. Unchanged from 6.7.10 through 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 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.