mirror of
https://github.com/WordPress/WordPress.git
synced 2024-07-01 09:15:02 +02:00
268203f8aa
Most block feature checks are for a single feature string, and for such cases it is not intuitive to require an array for the `$feature` parameter of the `block_has_support()` function. This changeset brings it in line with other functions like `post_type_supports()`, allowing to pass a string for the `$feature`. An array is still supported for more complex cases where support for sub-features needs to be determined. This change furthermore includes a very minor performance tweak by avoiding calls to the `_wp_array_get()` function if a single feature string is being checked for. Props thekt12, nihar007, mukesh27, swissspidy. Fixes #58532. Built from https://develop.svn.wordpress.org/trunk@56382 git-svn-id: http://core.svn.wordpress.org/trunk@55894 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, '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',
|
|
)
|
|
);
|