lib/block-supports/dimensions.php - trunk - githubmirror/gutenberg

lib/block-supports/dimensions.php
186 строк6 KB
tellthemachines
Add support for aspect ratio and related controls in viewport states (#78795)
12 июн 2026, 08:06
12 июн 2026, 08:060b846fc
<?php
/**
 * Dimensions block support flag.
 *
 * This does not include the `spacing` block support even though that visually
 * appears under the "Dimensions" panel in the editor. It remains in its
 * original `spacing.php` file for compatibility with core.
 *
 * @package gutenberg
 */

/**
 * Registers the style block attribute for block types that support it.
 *
 * @param WP_Block_Type $block_type Block Type.
 */
function gutenberg_register_dimensions_support( $block_type ) {
	// Setup attributes and styles within that if needed.
	if ( ! $block_type->attributes ) {
		$block_type->attributes = array();
	}

	// Check for existing style attribute definition e.g. from block.json.
	if ( array_key_exists( 'style', $block_type->attributes ) ) {
		return;
	}

	$has_dimensions_support = block_has_support( $block_type, array( 'dimensions' ), false );

	if ( $has_dimensions_support ) {
		$block_type->attributes['style'] = array(
			'type' => 'object',
		);
	}
}

/**
 * Add CSS classes for block dimensions to the incoming attributes array.
 * This will be applied to the block markup in the front-end.
 *
 * @param WP_Block_Type $block_type       Block Type.
 * @param array         $block_attributes Block attributes.
 *
 * @return array Block dimensions CSS classes and inline styles.
 */
function gutenberg_apply_dimensions_support( $block_type, $block_attributes ) {
	$attributes = array();

	if ( wp_should_skip_block_supports_serialization( $block_type, 'dimensions' ) ) {
		return $attributes;
	}

	$block_styles = $block_attributes['style'] ?? null;

	if ( ! $block_styles ) {
		return $attributes;
	}

	$dimensions_block_styles = array();
	$supported_features      = array( 'minHeight', 'minWidth', 'height', 'width' );

	foreach ( $supported_features as $feature ) {
		$has_support        = block_has_support( $block_type, array( 'dimensions', $feature ), false );
		$skip_serialization = wp_should_skip_block_supports_serialization( $block_type, 'dimensions', $feature );

		$dimensions_block_styles[ $feature ] = null;

		if ( $has_support && ! $skip_serialization ) {
			$dimensions_block_styles[ $feature ] = $block_styles['dimensions'][ $feature ] ?? null;
		}
	}

	$styles = gutenberg_style_engine_get_styles( array( 'dimensions' => $dimensions_block_styles ) );

	if ( ! empty( $styles['css'] ) ) {
		$attributes['style'] = $styles['css'];
	}

	return $attributes;
}

/**
 * Checks whether an aspectRatio block-support value is explicitly set.
 *
 * @param mixed $aspect_ratio Aspect-ratio value.
 * @return bool Whether the value is an explicit aspect ratio.
 */
function gutenberg_is_explicit_aspect_ratio_value( $aspect_ratio ) {
	if ( ! is_string( $aspect_ratio ) && ! is_numeric( $aspect_ratio ) ) {
		return false;
	}

	$aspect_ratio = strtolower( trim( (string) $aspect_ratio ) );

	return '' !== $aspect_ratio && 'auto' !== $aspect_ratio;
}

/**
 * Renders server-side dimensions styles to the block wrapper.
 * This block support uses the `render_block` hook to ensure that
 * it is also applied to non-server-rendered blocks.
 *
 * @param  string $block_content Rendered block content.
 * @param  array  $block         Block object.
 * @return string                Filtered block content.
 */
function gutenberg_render_dimensions_support( $block_content, $block ) {
	$block_type               = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
	$block_attributes         = ( isset( $block['attrs'] ) && is_array( $block['attrs'] ) ) ? $block['attrs'] : array();
	$has_aspect_ratio_support = block_has_support( $block_type, array( 'dimensions', 'aspectRatio' ), false );

	if (
		! $has_aspect_ratio_support ||
		wp_should_skip_block_supports_serialization( $block_type, 'dimensions', 'aspectRatio' )
	) {
		return $block_content;
	}

	$dimensions_block_styles                = array();
	$dimensions_block_styles['aspectRatio'] = $block_attributes['style']['dimensions']['aspectRatio'] ?? null;

	// To ensure the aspect ratio does not get overridden by `minHeight` or `height` unset any existing rule.
	if (
		gutenberg_is_explicit_aspect_ratio_value( $dimensions_block_styles['aspectRatio'] )
	) {
		$dimensions_block_styles['minHeight'] = 'unset';
		$dimensions_block_styles['height']    = 'unset';
	} elseif (
		isset( $block_attributes['style']['dimensions']['minHeight'] ) ||
		isset( $block_attributes['minHeight'] ) ||
		isset( $block_attributes['style']['dimensions']['height'] ) ||
		isset( $block_attributes['height'] )
	) {
		$dimensions_block_styles['aspectRatio'] = 'unset';
	}

	$styles = gutenberg_style_engine_get_styles( array( 'dimensions' => $dimensions_block_styles ) );

	if ( ! empty( $styles['css'] ) ) {
		// Inject dimensions styles to the first element, presuming it's the wrapper, if it exists.
		$tags = new WP_HTML_Tag_Processor( $block_content );

		if ( $tags->next_tag() ) {
			$existing_style = $tags->get_attribute( 'style' );
			$updated_style  = '';

			if ( ! empty( $existing_style ) ) {
				$updated_style = $existing_style;
				if ( ! str_ends_with( $existing_style, ';' ) ) {
					$updated_style .= ';';
				}
			}

			$updated_style .= $styles['css'];
			$tags->set_attribute( 'style', $updated_style );

			if ( ! empty( $styles['classnames'] ) ) {
				foreach ( explode( ' ', $styles['classnames'] ) as $class_name ) {
					if (
						str_contains( $class_name, 'aspect-ratio' ) &&
						! gutenberg_is_explicit_aspect_ratio_value( $block_attributes['style']['dimensions']['aspectRatio'] ?? null )
					) {
						continue;
					}
					$tags->add_class( $class_name );
				}
			}
		}

		return $tags->get_updated_html();
	}

	return $block_content;
}

remove_filter( 'render_block', 'wp_render_dimensions_support', 10 );
add_filter( 'render_block', 'gutenberg_render_dimensions_support', 10, 2 );

// Register the block support.
WP_Block_Supports::get_instance()->register(
	'dimensions',
	array(
		'register_attribute' => 'gutenberg_register_dimensions_support',
		'apply'              => 'gutenberg_apply_dimensions_support',
	)
);