Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WordPress 6.3 backport: Add box shadow support to blocks #4696

Closed
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions src/wp-includes/block-supports/shadow.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<?php
/**
* Shadow block support flag.
*
* @package WordPress
* @since 6.3.0
*/

/**
* Registers the style and shadow block attributes for block types that support it.
*
* @since 6.3.0
* @access private
*
* @param WP_Block_Type $block_type Block Type.
*/
function wp_register_shadow_support( $block_type ) {
$has_shadow_support = block_has_support( $block_type, array( 'shadow' ), false );

if ( ! $has_shadow_support ) {
return;
}

if ( ! $block_type->attributes ) {
$block_type->attributes = array();
}

if ( $has_shadow_support && ! array_key_exists( 'style', $block_type->attributes ) ) {
ramonjd marked this conversation as resolved.
Show resolved Hide resolved
$block_type->attributes['style'] = array(
'type' => 'object',
);
}

if ( $has_shadow_support && ! array_key_exists( 'shadow', $block_type->attributes ) ) {
ramonjd marked this conversation as resolved.
Show resolved Hide resolved
$block_type->attributes['shadow'] = array(
'type' => 'string',
);
}
}

/**
* Add CSS classes and inline styles for shadow features to the incoming attributes array.
* This will be applied to the block markup in the front-end.
*
* @since 6.3.0
* @access private
*
* @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes.
*
ramonjd marked this conversation as resolved.
Show resolved Hide resolved
* @return array Shadow CSS classes and inline styles.
*/
function wp_apply_shadow_support( $block_type, $block_attributes ) {
$has_shadow_support = block_has_support( $block_type, array( 'shadow' ), false );

if ( ! $has_shadow_support ) {
return array();
}

$shadow_block_styles = array();

$preset_shadow = array_key_exists( 'shadow', $block_attributes ) ? "var:preset|shadow|{$block_attributes['shadow']}" : null;
$custom_shadow = isset( $block_attributes['style']['shadow'] ) ? $block_attributes['style']['shadow'] : null;
$shadow_block_styles['shadow'] = $preset_shadow ? $preset_shadow : $custom_shadow;

$attributes = array();
$styles = wp_style_engine_get_styles( $shadow_block_styles );

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

return $attributes;
}

// Register the block support.
WP_Block_Supports::get_instance()->register(
'shadow',
array(
'register_attribute' => 'wp_register_shadow_support',
'apply' => 'wp_apply_shadow_support',
)
);
1 change: 1 addition & 0 deletions src/wp-includes/kses.php
Original file line number Diff line number Diff line change
Expand Up @@ -2447,6 +2447,7 @@ function safecss_filter_attr( $css, $deprecated = '' ) {
'bottom',
'left',
'z-index',
'box-shadow',
ramonjd marked this conversation as resolved.
Show resolved Hide resolved
'aspect-ratio',

// Custom CSS properties.
Expand Down
11 changes: 11 additions & 0 deletions src/wp-includes/style-engine/class-wp-style-engine.php
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,17 @@ final class WP_Style_Engine {
),
),
),
'shadow' => array(
'shadow' => array(
'property_keys' => array(
'default' => 'box-shadow',
),
'path' => array( 'shadow' ),
'css_vars' => array(
'shadow' => '--wp--preset--shadow--$slug',
),
),
),
'dimensions' => array(
'minHeight' => array(
'property_keys' => array(
Expand Down
1 change: 1 addition & 0 deletions src/wp-settings.php
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,7 @@
require ABSPATH . WPINC . '/block-supports/custom-classname.php';
require ABSPATH . WPINC . '/block-supports/dimensions.php';
require ABSPATH . WPINC . '/block-supports/duotone.php';
require ABSPATH . WPINC . '/block-supports/shadow.php';
require ABSPATH . WPINC . '/block-supports/elements.php';
require ABSPATH . WPINC . '/block-supports/generated-classname.php';
require ABSPATH . WPINC . '/block-supports/layout.php';
Expand Down
89 changes: 89 additions & 0 deletions tests/phpunit/tests/block-supports/shadow.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?php
/**
* @group block-supports
*
* @covers ::wp_apply_shadow_support
*/
class Test_Block_Supports_Shadow extends WP_UnitTestCase {
/**
* @var string|null
*/
private $test_block_name;

public function set_up() {
parent::set_up();
$this->test_block_name = null;
}

public function tear_down() {
unregister_block_type( $this->test_block_name );
$this->test_block_name = null;
parent::set_up();
}

/**
* @ticket 58590
*/
public function test_shadow_style_is_applied() {
$this->test_block_name = 'test/shadow-style-is-applied';
register_block_type(
$this->test_block_name,
array(
'api_version' => 3,
'attributes' => array(
'style' => array(
'type' => 'object',
),
),
'supports' => array(
'shadow' => true,
),
)
);
$registry = WP_Block_Type_Registry::get_instance();
$block_type = $registry->get_registered( $this->test_block_name );
$block_atts = array(
'style' => array(
'shadow' => '60px -16px teal',
),
);

$actual = wp_apply_shadow_support( $block_type, $block_atts );
$expected = array(
'style' => 'box-shadow:60px -16px teal;',
);

$this->assertSame( $expected, $actual );
}

/**
* @ticket 58590
*/
public function test_shadow_without_block_supports() {
$this->test_block_name = 'test/shadow-with-skipped-serialization-block-supports';
register_block_type(
$this->test_block_name,
array(
'api_version' => 2,
'attributes' => array(
'style' => array(
'type' => 'object',
),
),
'supports' => array(),
)
);
$registry = WP_Block_Type_Registry::get_instance();
$block_type = $registry->get_registered( $this->test_block_name );
$block_atts = array(
'style' => array(
'shadow' => '60px -16px teal',
),
);

$actual = wp_apply_spacing_support( $block_type, $block_atts );
$expected = array();

$this->assertSame( $expected, $actual );
}
}
14 changes: 14 additions & 0 deletions tests/phpunit/tests/style-engine/styleEngine.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public function tear_down() {
*
* @ticket 56467
* @ticket 58549
* @ticket 58590
*
* @covers ::wp_style_engine_get_styles
*
Expand Down Expand Up @@ -182,6 +183,19 @@ public function data_wp_style_engine_get_styles() {
),
),

'inline_valid_shadow_style' => array(
'block_styles' => array(
'shadow' => 'inset 5em 1em gold',
),
'options' => null,
'expected_output' => array(
'css' => 'box-shadow:inset 5em 1em gold;',
'declarations' => array(
'box-shadow' => 'inset 5em 1em gold',
),
),
),

'inline_valid_typography_style' => array(
'block_styles' => array(
'typography' => array(
Expand Down