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

Description

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_dimensions_support() 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

22–100

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

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 one call costs · 8 distinct outcomes

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

Uses · 9

• block_has_support()Checks whether the current block type supports the feature requested.
• wp_should_skip_block_supports_serialization()Checks whether serialization of the current block's supported properties should occur.
• wp_is_explicit_aspect_ratio_value()Checks whether an aspectRatio block-support value is explicitly set.
• wp_style_engine_get_styles()Global public interface method to generate styles from a single style object, e.g. the value of a block's attributes.style object or the top level styles in theme.json.
• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• 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.
• WP_HTML_Tag_Processor::__construct()Constructor.

Source code

View on Trac ↗View on GitHub ↗

120function wp_render_dimensions_support( $block_content, $block ) {121	$block_type               = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );122	$block_attributes         = ( isset( $block['attrs'] ) && is_array( $block['attrs'] ) ) ? $block['attrs'] : array();123	$has_aspect_ratio_support = block_has_support( $block_type, array( 'dimensions', 'aspectRatio' ), false );124 125	if (126		! $has_aspect_ratio_support ||127		wp_should_skip_block_supports_serialization( $block_type, 'dimensions', 'aspectRatio' )128	) {129		return $block_content;130	}131 132	$dimensions_block_styles                = array();133	$dimensions_block_styles['aspectRatio'] = $block_attributes['style']['dimensions']['aspectRatio'] ?? null;134 135	// To ensure the aspect ratio does not get overridden by `minHeight` or `height` unset any existing rule.136	if (137		wp_is_explicit_aspect_ratio_value( $dimensions_block_styles['aspectRatio'] )138	) {139		$dimensions_block_styles['minHeight'] = 'unset';140		$dimensions_block_styles['height']    = 'unset';141	} elseif (142		isset( $block_attributes['style']['dimensions']['minHeight'] ) ||143		isset( $block_attributes['minHeight'] )144	) {145		$dimensions_block_styles['aspectRatio'] = 'unset';146	}147 148	$styles = wp_style_engine_get_styles( array( 'dimensions' => $dimensions_block_styles ) );149 150	if ( ! empty( $styles['css'] ) ) {151		// Inject dimensions styles to the first element, presuming it's the wrapper, if it exists.152		$tags = new WP_HTML_Tag_Processor( $block_content );153 154		if ( $tags->next_tag() ) {155			$existing_style = $tags->get_attribute( 'style' );156			$updated_style  = '';157 158			if ( ! empty( $existing_style ) ) {159				$updated_style = $existing_style;160				if ( ! str_ends_with( $existing_style, ';' ) ) {161					$updated_style .= ';';162				}163			}164 165			$updated_style .= $styles['css'];166			$tags->set_attribute( 'style', $updated_style );167 168			if ( ! empty( $styles['classnames'] ) ) {169				foreach ( explode( ' ', $styles['classnames'] ) as $class_name ) {170					if (171						str_contains( $class_name, 'aspect-ratio' ) &&172						! wp_is_explicit_aspect_ratio_value( $block_attributes['style']['dimensions']['aspectRatio'] ?? null )173					) {174						continue;175					}176					$tags->add_class( $class_name );177				}178			}179		}180 181		return $tags->get_updated_html();182	}183 184	return $block_content;185}

Changelog

Introduced in 6.5.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/dimensions.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.