WP_Theme_JSON::get_layout_styles( array $block_metadata, 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

$block_metadataarray

Metadata about the block to get styles for.

$optionsarrayoptional

An array of options for now used for internal purposes only.Default: array()

Return value

string

Layout styles for the block.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

41–78

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places 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_Theme_JSON::get_layout_styles()

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme_JSON::get_layout_styles() 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 · 10

• current_theme_supports()Checks a theme's support for a given feature.
• block_has_support()Checks whether the current block type supports the feature requested.
• _wp_array_get()Accesses an array in depth based on a path of keys.
• wp_get_layout_definitions()Returns layout definitions, keyed by layout type.
• 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.
• static::get_property_value()
• static::is_safe_css_declaration()
• static::to_ruleset()

Used by · 2

• WP_Theme_JSON::get_root_layout_rules()Outputs the CSS for layout rules on the root.
• WP_Theme_JSON::get_styles_for_block()Gets the CSS rules for a particular block from theme.json.

Source code

View on Trac ↗View on GitHub ↗

2219	protected function get_layout_styles( $block_metadata, $options = array() ) {2220		$block_rules = '';2221		$block_type  = null;2222 2223		// Skip outputting layout styles if explicitly disabled.2224		if ( current_theme_supports( 'disable-layout-styles' ) ) {2225			return $block_rules;2226		}2227 2228		if ( isset( $block_metadata['name'] ) ) {2229			$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_metadata['name'] );2230			if ( ! block_has_support( $block_type, 'layout', false ) && ! block_has_support( $block_type, '__experimentalLayout', false ) ) {2231				return $block_rules;2232			}2233		}2234 2235		$selector                 = $block_metadata['selector'] ?? '';2236		$has_block_gap_support    = isset( $this->theme_json['settings']['spacing']['blockGap'] );2237		$has_fallback_gap_support = ! $has_block_gap_support; // This setting isn't useful yet: it exists as a placeholder for a future explicit fallback gap styles support.2238		$node                     = $options['node'] ?? _wp_array_get( $this->theme_json, $block_metadata['path'], array() );2239		$layout_definitions       = wp_get_layout_definitions();2240		$layout_selector_pattern  = '/^[a-zA-Z0-9\-\.\,\ *+>:\(\)]*$/'; // Allow alphanumeric classnames, spaces, wildcard, sibling, child combinator and pseudo class selectors.2241 2242		/*2243		 * Gap styles will only be output if the theme has block gap support, or supports a fallback gap.2244		 * Default layout gap styles will be skipped for themes that do not explicitly opt-in to blockGap with a `true` or `false` value.2245		 */2246		if ( $has_block_gap_support || $has_fallback_gap_support ) {2247			$block_gap_value = null;2248			// Use a fallback gap value if block gap support is not available.2249			if ( ! $has_block_gap_support ) {2250				$block_gap_value = static::ROOT_BLOCK_SELECTOR === $selector ? '0.5em' : null;2251				if ( ! empty( $block_type ) ) {2252					$block_gap_value = $block_type->supports['spacing']['blockGap']['__experimentalDefault'] ?? null;2253				}2254			} else {2255				$block_gap_value = static::get_property_value( $node, array( 'spacing', 'blockGap' ) );2256			}2257 2258			// Support split row / column values and concatenate to a shorthand value.2259			if ( is_array( $block_gap_value ) ) {2260				if ( isset( $block_gap_value['top'] ) && isset( $block_gap_value['left'] ) ) {2261					$gap_row         = static::get_property_value( $node, array( 'spacing', 'blockGap', 'top' ) );2262					$gap_column      = static::get_property_value( $node, array( 'spacing', 'blockGap', 'left' ) );2263					$block_gap_value = $gap_row === $gap_column ? $gap_row : $gap_row . ' ' . $gap_column;2264				} else {2265					// Skip outputting gap value if not all sides are provided.2266					$block_gap_value = null;2267				}2268			}2269 2270			// If the block should have custom gap, add the gap styles.2271			if ( null !== $block_gap_value && false !== $block_gap_value && '' !== $block_gap_value ) {2272				foreach ( $layout_definitions as $layout_definition_key => $layout_definition ) {2273					// Allow outputting fallback gap styles for flex and grid layout types when block gap support isn't available.2274					if ( ! $has_block_gap_support && 'flex' !== $layout_definition_key && 'grid' !== $layout_definition_key ) {2275						continue;2276					}2277 2278					$class_name    = $layout_definition['className'] ?? false;2279					$spacing_rules = $layout_definition['spacingStyles'] ?? array();2280 2281					if (2282						! empty( $class_name ) &&2283						! empty( $spacing_rules )2284					) {2285						foreach ( $spacing_rules as $spacing_rule ) {2286							$declarations = array();2287							if (2288								isset( $spacing_rule['selector'] ) &&2289								preg_match( $layout_selector_pattern, $spacing_rule['selector'] ) &&2290								! empty( $spacing_rule['rules'] )2291							) {2292								// Iterate over each of the styling rules and substitute non-string values such as `null` with the real `blockGap` value.2293								foreach ( $spacing_rule['rules'] as $css_property => $css_value ) {2294									$current_css_value = is_string( $css_value ) ? $css_value : $block_gap_value;2295									if ( static::is_safe_css_declaration( $css_property, $current_css_value ) ) {2296										$declarations[] = array(2297											'name'  => $css_property,2298											'value' => $current_css_value,

Changelog

Introduced in 6.1.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/class-wp-theme-json.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.