WP_Theme_JSON::get_layout_styles( array $block_metadata, array $options = array() ): string

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

string

Layout styles for the block.

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

View on Trac ↗View on GitHub ↗

1700	protected function get_layout_styles( $block_metadata, $options = array() ) {1701		$block_rules = '';1702		$block_type  = null;1703 1704		// Skip outputting layout styles if explicitly disabled.1705		if ( current_theme_supports( 'disable-layout-styles' ) ) {1706			return $block_rules;1707		}1708 1709		if ( isset( $block_metadata['name'] ) ) {1710			$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_metadata['name'] );1711			if ( ! block_has_support( $block_type, 'layout', false ) && ! block_has_support( $block_type, '__experimentalLayout', false ) ) {1712				return $block_rules;1713			}1714		}1715 1716		$selector                 = $block_metadata['selector'] ?? '';1717		$has_block_gap_support    = isset( $this->theme_json['settings']['spacing']['blockGap'] );1718		$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.1719		$node                     = $options['node'] ?? _wp_array_get( $this->theme_json, $block_metadata['path'], array() );1720		$layout_definitions       = wp_get_layout_definitions();1721		$layout_selector_pattern  = '/^[a-zA-Z0-9\-\.\,\ *+>:\(\)]*$/'; // Allow alphanumeric classnames, spaces, wildcard, sibling, child combinator and pseudo class selectors.1722 1723		/*1724		 * Gap styles will only be output if the theme has block gap support, or supports a fallback gap.1725		 * Default layout gap styles will be skipped for themes that do not explicitly opt-in to blockGap with a `true` or `false` value.1726		 */1727		if ( $has_block_gap_support || $has_fallback_gap_support ) {1728			$block_gap_value = null;1729			// Use a fallback gap value if block gap support is not available.1730			if ( ! $has_block_gap_support ) {1731				$block_gap_value = static::ROOT_BLOCK_SELECTOR === $selector ? '0.5em' : null;1732				if ( ! empty( $block_type ) ) {1733					$block_gap_value = $block_type->supports['spacing']['blockGap']['__experimentalDefault'] ?? null;1734				}1735			} else {1736				$block_gap_value = static::get_property_value( $node, array( 'spacing', 'blockGap' ) );1737			}1738 1739			// Support split row / column values and concatenate to a shorthand value.1740			if ( is_array( $block_gap_value ) ) {1741				if ( isset( $block_gap_value['top'] ) && isset( $block_gap_value['left'] ) ) {1742					$gap_row         = static::get_property_value( $node, array( 'spacing', 'blockGap', 'top' ) );1743					$gap_column      = static::get_property_value( $node, array( 'spacing', 'blockGap', 'left' ) );1744					$block_gap_value = $gap_row === $gap_column ? $gap_row : $gap_row . ' ' . $gap_column;1745				} else {1746					// Skip outputting gap value if not all sides are provided.1747					$block_gap_value = null;1748				}1749			}1750 1751			// If the block should have custom gap, add the gap styles.1752			if ( null !== $block_gap_value && false !== $block_gap_value && '' !== $block_gap_value ) {1753				foreach ( $layout_definitions as $layout_definition_key => $layout_definition ) {1754					// Allow outputting fallback gap styles for flex and grid layout types when block gap support isn't available.1755					if ( ! $has_block_gap_support && 'flex' !== $layout_definition_key && 'grid' !== $layout_definition_key ) {1756						continue;1757					}1758 1759					$class_name    = $layout_definition['className'] ?? false;1760					$spacing_rules = $layout_definition['spacingStyles'] ?? array();1761 1762					if (1763						! empty( $class_name ) &&1764						! empty( $spacing_rules )1765					) {1766						foreach ( $spacing_rules as $spacing_rule ) {1767							$declarations = array();1768							if (1769								isset( $spacing_rule['selector'] ) &&1770								preg_match( $layout_selector_pattern, $spacing_rule['selector'] ) &&1771								! empty( $spacing_rule['rules'] )1772							) {1773								// Iterate over each of the styling rules and substitute non-string values such as `null` with the real `blockGap` value.1774								foreach ( $spacing_rule['rules'] as $css_property => $css_value ) {1775									$current_css_value = is_string( $css_value ) ? $css_value : $block_gap_value;1776									if ( static::is_safe_css_declaration( $css_property, $current_css_value ) ) {1777										$declarations[] = array(1778											'name'  => $css_property,1779											'value' => $current_css_value,

History

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.0.4 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.