wp_render_layout_support_flag( string $block_content, array $block ): 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

$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

163–276

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

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, query 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 · 17 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 · 22

• block_has_support()Checks whether the current block type supports the feature requested.
• wp_get_global_settings()Gets the settings resulting of merging core, theme, and user data.
• wp_get_layout_child_values()Returns the child-layout-only subset of a layout object.
• wp_unique_id_from_values()Generates a unique ID based on the structure and values of a given array.
• wp_get_child_layout_style_rules()Returns child layout styles for a block affected by its parent's layout.
• wp_style_engine_get_stylesheet_from_css_rules()Returns compiled CSS from a collection of selectors and declarations.
• 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_sanitize_block_gap_value()Sanitizes a block gap value before layout style generation.
• wp_should_skip_block_supports_serialization()Checks whether serialization of the current block's supported properties should occur.
• wp_get_global_styles()Gets the styles resulting of merging core, theme, and user data.

Source code

View on Trac ↗View on GitHub ↗

955function wp_render_layout_support_flag( $block_content, $block ) {956	static $global_styles = null;957 958	$block_type            = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );959	$block_supports_layout = block_has_support( $block_type, 'layout', false ) || block_has_support( $block_type, '__experimentalLayout', false );960	$style_attr            = $block['attrs']['style'] ?? array();961	/*962	 * A block with no layout support and no style attribute at all cannot963	 * produce layout output, so return before resolving global settings.964	 *965	 * Resolving settings is not read-only: on a cold cache it queries the966	 * user's `wp_global_styles` post, which fires `the_posts`. A callback on967	 * that hook that renders blocks re-enters this filter, and the content it968	 * renders at that point is the global styles post itself, which parses to a969	 * single block with no name and no attributes. Without this return that970	 * block resolves settings again and the recursion has no base case.971	 */972	if ( ! $block_supports_layout && empty( $style_attr ) ) {973		return $block_content;974	}975 976	$global_settings          = wp_get_global_settings();977	$viewport_settings        = $global_settings['viewport'] ?? null;978	$responsive_media_queries = WP_Theme_JSON::get_viewport_media_queries( $viewport_settings );979	$child_layout             = $style_attr['layout'] ?? null;980 981	/*982	 * Collect responsive viewport child layout overrides so that a block with983	 * only responsive child layout (no base child layout) is still processed.984	 */985	$viewport_child_layouts = array();986	foreach ( $responsive_media_queries as $breakpoint => $media_query ) {987		$viewport_child = wp_get_layout_child_values( $style_attr[ $breakpoint ]['layout'] ?? null );988 989		if ( ! empty( $viewport_child ) ) {990			$viewport_child_layouts[ $breakpoint ] = array(991				'media_query'  => $media_query,992				'child_layout' => $viewport_child,993			);994		}995	}996 997	if ( ! $block_supports_layout && ! $child_layout && empty( $viewport_child_layouts ) ) {998		return $block_content;999	}1000 1001	$outer_class_names = array();1002 1003	// Child layout specific logic.1004	if ( $child_layout || ! empty( $viewport_child_layouts ) ) {1005		$base_child_layout = wp_get_layout_child_values( $child_layout );1006		$parent_layout     = $block['parentLayout'] ?? array();1007		/*1008		 * Generates a unique class for child block layout styles.1009		 *1010		 * To ensure consistent class generation across different page renders,1011		 * only properties that affect layout styling are used. These properties1012		 * come from `$block['attrs']['style']['layout']`, viewport overrides in1013		 * `$block['attrs']['style'][$breakpoint]['layout']`, and `$block['parentLayout']`.1014		 *1015		 * As long as these properties coincide, the generated class will be the same.1016		 */1017		$container_content_hash_input = array(1018			'layout'       => $base_child_layout,1019			'parentLayout' => array_intersect_key(1020				$parent_layout,1021				array_flip( array( 'minimumColumnWidth', 'columnCount' ) )1022			),1023		);1024 1025		foreach ( $viewport_child_layouts as $breakpoint => $viewport_data ) {1026			$container_content_hash_input[ $breakpoint ] = $viewport_data['child_layout'];1027		}1028 1029		$container_content_class = wp_unique_id_from_values(1030			$container_content_hash_input,1031			'wp-container-content-'1032		);1033 1034		$child_layout_styles = wp_get_child_layout_style_rules( ".$container_content_class", $base_child_layout, $parent_layout );

Changelog

Introduced in 5.8.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.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.