mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-23 17:48:01 +01:00
048b304deb
This changeset adds the new dimension feature's PHP code for supporting minimum height in the block editor inspector and in global styles. Minimum height is quite useful for defining the minimum vertical dimensions of a block, while allowing it to expand beyond that size. In this changeset: * Adds support in `theme.json`. * Adds support in the style engine. * Adds support in `wp_apply_dimensions_support()`. * Renames the setting from `'__experimentalDimensions'` to `dimensions` in `wp_register_dimensions_support()`. * Adds PHPUnit tests. Is renaming `'__experimentalDimensions'` a backwards-compatibility (BC) break? Though the setting has been in the code since 5.9.0, it was never wired to anything, ie it did not expose any controls or styles. Notice in `wp_register_dimensions_support()` and `wp_apply_dimensions_support()` prior to this changeset, there are inline comments as placeholders for height and width support, but no code. If a developer opted in to use it, it had no effect. A search in wp.org's plugin and themes repo showed no instances of this experimental setting. Given there was no functionality attached to it (until this changeset), no change in behavior or effect from removing it, and no usage found in the plugins and themes repository, it does appear to be a BC break. References: * [https://github.com/WordPress/gutenberg/pull/45300 Gutenberg PR 45300] * [https://github.com/WordPress/gutenberg/pull/45334 Gutenberg PR 45334] Follow-up to [53076], [52069]. Props andrewserong, aaronrobertshaw , costdev, hellofromTonya, isabel_brison, joen, paaljoachim, mukesh27, ntsekouras, oandregal, ramonopoly. Fixes #57582. Built from https://develop.svn.wordpress.org/trunk@55175 git-svn-id: http://core.svn.wordpress.org/trunk@54708 1a063a9b-81f0-0310-95a4-ce76da25c4cd
89 lines
2.7 KiB
PHP
89 lines
2.7 KiB
PHP
<?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 WordPress
|
|
* @since 5.9.0
|
|
*/
|
|
|
|
/**
|
|
* Registers the style block attribute for block types that support it.
|
|
*
|
|
* @since 5.9.0
|
|
* @access private
|
|
*
|
|
* @param WP_Block_Type $block_type Block Type.
|
|
*/
|
|
function wp_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',
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds CSS classes for block dimensions to the incoming attributes array.
|
|
* This will be applied to the block markup in the front-end.
|
|
*
|
|
* @since 5.9.0
|
|
* @since 6.2.0 Added `minHeight` support.
|
|
* @access private
|
|
*
|
|
* @param WP_Block_Type $block_type Block Type.
|
|
* @param array $block_attributes Block attributes.
|
|
* @return array Block dimensions CSS classes and inline styles.
|
|
*/
|
|
function wp_apply_dimensions_support( $block_type, $block_attributes ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
|
|
if ( wp_should_skip_block_supports_serialization( $block_type, 'dimensions' ) ) {
|
|
return array();
|
|
}
|
|
|
|
$attributes = array();
|
|
|
|
// Width support to be added in near future.
|
|
|
|
$has_min_height_support = block_has_support( $block_type, array( 'dimensions', 'minHeight' ), false );
|
|
$block_styles = isset( $block_attributes['style'] ) ? $block_attributes['style'] : null;
|
|
|
|
if ( ! $block_styles ) {
|
|
return $attributes;
|
|
}
|
|
|
|
$skip_min_height = wp_should_skip_block_supports_serialization( $block_type, 'dimensions', 'minHeight' );
|
|
$dimensions_block_styles = array();
|
|
$dimensions_block_styles['minHeight'] = $has_min_height_support && ! $skip_min_height ? _wp_array_get( $block_styles, array( 'dimensions', 'minHeight' ), null ) : null;
|
|
$styles = wp_style_engine_get_styles( array( 'dimensions' => $dimensions_block_styles ) );
|
|
|
|
if ( ! empty( $styles['css'] ) ) {
|
|
$attributes['style'] = $styles['css'];
|
|
}
|
|
|
|
return $attributes;
|
|
}
|
|
|
|
// Register the block support.
|
|
WP_Block_Supports::get_instance()->register(
|
|
'dimensions',
|
|
array(
|
|
'register_attribute' => 'wp_register_dimensions_support',
|
|
'apply' => 'wp_apply_dimensions_support',
|
|
)
|
|
);
|