WP_Theme_JSON::get_root_layout_rules( string $selector, 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

$selectorstring

The root node selector.

$block_metadataarray

The metadata for the root block.

$optionsarrayoptional

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

Return value

string

The additional root rules CSS.

Performance profile

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

34–102

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

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 · 4 distinct outcomes

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

Uses · 3

• static::is_safe_css_declaration()
• static::get_property_value()
• WP_Theme_JSON::get_layout_styles()Gets the CSS layout rules for a particular block from theme.json layout definitions.

Used by · 1

• WP_Theme_JSON::get_stylesheet()Returns the stylesheet that results of processing the theme.json structure this object represents.

Source code

View on Trac ↗View on GitHub ↗

4203	public function get_root_layout_rules( $selector, $block_metadata, $options = array() ) {4204		$css              = '';4205		$settings         = $this->theme_json['settings'] ?? array();4206		$use_root_padding = isset( $this->theme_json['settings']['useRootPaddingAwareAlignments'] ) && true === $this->theme_json['settings']['useRootPaddingAwareAlignments'];4207 4208		/*4209		 * If there are content and wide widths in theme.json, output them4210		 * as custom properties on the body element so all blocks can use them.4211		 */4212		if ( isset( $settings['layout']['contentSize'] ) || isset( $settings['layout']['wideSize'] ) ) {4213			$content_size = $settings['layout']['contentSize'] ?? $settings['layout']['wideSize'];4214			$content_size = static::is_safe_css_declaration( 'max-width', $content_size ) ? $content_size : 'initial';4215			$wide_size    = $settings['layout']['wideSize'] ?? $settings['layout']['contentSize'];4216			$wide_size    = static::is_safe_css_declaration( 'max-width', $wide_size ) ? $wide_size : 'initial';4217			$css         .= static::ROOT_CSS_PROPERTIES_SELECTOR . ' { --wp--style--global--content-size: ' . $content_size . ';';4218			$css         .= '--wp--style--global--wide-size: ' . $wide_size . '; }';4219		}4220 4221		/*4222		 * Reset default browser margin on the body element.4223		 * This is set on the body selector **before** generating the ruleset4224		 * from the `theme.json`. This is to ensure that if the `theme.json` declares4225		 * `margin` in its `spacing` declaration for the `body` element then these4226		 * user-generated values take precedence in the CSS cascade.4227		 * @link https://github.com/WordPress/gutenberg/issues/36147.4228		 */4229		$css .= ':where(body) { margin: 0; }';4230 4231		if ( $use_root_padding ) {4232			// Top and bottom padding are applied to the outer block container.4233			$css .= '.wp-site-blocks { padding-top: var(--wp--style--root--padding-top); padding-bottom: var(--wp--style--root--padding-bottom); }';4234			// Right and left padding are applied to the first container with `.has-global-padding` class.4235			$css .= '.has-global-padding { padding-right: var(--wp--style--root--padding-right); padding-left: var(--wp--style--root--padding-left); }';4236			// Alignfull children of the container with left and right padding have negative margins so they can still be full width.4237			$css .= '.has-global-padding > .alignfull { margin-right: calc(var(--wp--style--root--padding-right) * -1); margin-left: calc(var(--wp--style--root--padding-left) * -1); }';4238			// Nested children of the container with left and right padding that are not full aligned do not get padding, unless they are direct children of an alignfull flow container.4239			$css .= '.has-global-padding :where(:not(.alignfull.is-layout-flow) > .has-global-padding:not(.wp-block-block, .alignfull)) { padding-right: 0; padding-left: 0; }';4240			// Alignfull direct children of the containers that are targeted by the rule above do not need negative margins.4241			$css .= '.has-global-padding :where(:not(.alignfull.is-layout-flow) > .has-global-padding:not(.wp-block-block, .alignfull)) > .alignfull { margin-left: 0; margin-right: 0; }';4242		}4243 4244		// Skip outputting alignment styles when base_layout_styles is enabled.4245		// These styles target .wp-site-blocks which is only used by block themes.4246		if ( empty( $options['base_layout_styles'] ) ) {4247			$css .= '.wp-site-blocks > .alignleft { float: left; margin-right: 2em; }';4248			$css .= '.wp-site-blocks > .alignright { float: right; margin-left: 2em; }';4249			$css .= '.wp-site-blocks > .aligncenter { justify-content: center; margin-left: auto; margin-right: auto; }';4250		}4251 4252		// Block gap styles will be output unless explicitly set to `null`.4253		if ( isset( $this->theme_json['settings']['spacing']['blockGap'] ) ) {4254			$block_gap_value = static::get_property_value( $this->theme_json, array( 'styles', 'spacing', 'blockGap' ) );4255			$css            .= ":where(.wp-site-blocks) > * { margin-block-start: $block_gap_value; margin-block-end: 0; }";4256			$css            .= ':where(.wp-site-blocks) > :first-child { margin-block-start: 0; }';4257			$css            .= ':where(.wp-site-blocks) > :last-child { margin-block-end: 0; }';4258 4259			// For backwards compatibility, ensure the legacy block gap CSS variable is still available.4260			$css .= static::ROOT_CSS_PROPERTIES_SELECTOR . " { --wp--style--block-gap: $block_gap_value; }";4261		}4262		$css .= $this->get_layout_styles( $block_metadata, $options );4263 4264		return $css;4265	}

Changelog

Introduced in 6.1.0. One change 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.