mirrored from git://develop.git.wordpress.org/
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Block support: Add server-side processing for ariaLabel #8274
Open
t-hamano
wants to merge
1
commit into
WordPress:trunk
Choose a base branch
from
t-hamano:aria-label-server-side-support
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+202
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
<?php | ||
/** | ||
* Aria label block support flag. | ||
* | ||
* @package WordPress | ||
* @since 6.8.0 | ||
*/ | ||
|
||
/** | ||
* Registers the aria-label block attribute for block types that support it. | ||
* | ||
* @since 6.8.0 | ||
* @access private | ||
* | ||
* @param WP_Block_Type $block_type Block Type. | ||
*/ | ||
function wp_register_aria_label_support( $block_type ) { | ||
$has_aria_label_support = block_has_support( $block_type, array( 'ariaLabel' ), false ); | ||
|
||
if ( ! $has_aria_label_support ) { | ||
return; | ||
} | ||
|
||
if ( ! $block_type->attributes ) { | ||
$block_type->attributes = array(); | ||
} | ||
|
||
if ( ! array_key_exists( 'ariaLabel', $block_type->attributes ) ) { | ||
$block_type->attributes['ariaLabel'] = array( | ||
'type' => 'string', | ||
); | ||
} | ||
} | ||
|
||
/** | ||
* Add the aria-label to the output. | ||
* | ||
* @since 6.8.0 | ||
* @access private | ||
* | ||
* @param WP_Block_Type $block_type Block Type. | ||
* @param array $block_attributes Block attributes. | ||
* | ||
* @return array Block aria-label. | ||
*/ | ||
function wp_apply_aria_label_support( $block_type, $block_attributes ) { | ||
if ( ! $block_attributes ) { | ||
return array(); | ||
} | ||
|
||
$has_aria_label_support = block_has_support( $block_type, array( 'ariaLabel' ), false ); | ||
if ( ! $has_aria_label_support ) { | ||
return array(); | ||
} | ||
|
||
$has_aria_label = array_key_exists( 'ariaLabel', $block_attributes ); | ||
if ( ! $has_aria_label ) { | ||
return array(); | ||
} | ||
return array( 'aria-label' => $block_attributes['ariaLabel'] ); | ||
} | ||
|
||
// Register the block support. | ||
WP_Block_Supports::get_instance()->register( | ||
'aria-label', | ||
array( | ||
'register_attribute' => 'wp_register_aria_label_support', | ||
'apply' => 'wp_apply_aria_label_support', | ||
) | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
<?php | ||
/** | ||
* @group block-supports | ||
* | ||
* @covers ::wp_apply_aria_label_support | ||
*/ | ||
class Tests_Block_Supports_Aria_Label 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::tear_down(); | ||
} | ||
|
||
/** | ||
* Registers a new block for testing aria-label support. | ||
* | ||
* @param string $block_name Name for the test block. | ||
* @param array $supports Array defining block support configuration. | ||
* | ||
* @return WP_Block_Type The block type for the newly registered test block. | ||
*/ | ||
private function register_aria_label_block_with_support( $block_name, $supports = array() ) { | ||
$this->test_block_name = $block_name; | ||
register_block_type( | ||
$this->test_block_name, | ||
array( | ||
'api_version' => 3, | ||
'supports' => $supports, | ||
) | ||
); | ||
$registry = WP_Block_Type_Registry::get_instance(); | ||
|
||
return $registry->get_registered( $this->test_block_name ); | ||
} | ||
|
||
/** | ||
* Tests that position block support works as expected. | ||
* | ||
* @ticket 62919 | ||
* | ||
* @dataProvider data_aria_label_block_support | ||
* | ||
* @param boolean|array $support Aria label block support configuration. | ||
* @param string $value Aria label value for attribute object. | ||
* @param array $expected Expected aria label block support styles. | ||
*/ | ||
public function test_wp_apply_aria_label_support( $support, $value, $expected ) { | ||
$block_type = self::register_aria_label_block_with_support( | ||
'test/aria-label-block', | ||
array( 'ariaLabel' => $support ) | ||
); | ||
$block_attrs = array( 'ariaLabel' => $value ); | ||
$actual = wp_apply_aria_label_support( $block_type, $block_attrs ); | ||
|
||
$this->assertSame( $expected, $actual ); | ||
} | ||
|
||
/** | ||
* Data provider. | ||
* | ||
* @return array | ||
*/ | ||
public function data_aria_label_block_support() { | ||
return array( | ||
'aria-label attribute is applied' => array( | ||
'support' => true, | ||
'value' => 'Label', | ||
'expected' => array( 'aria-label' => 'Label' ), | ||
), | ||
'aria-label attribute is not applied if block does not support it' => array( | ||
'support' => false, | ||
'value' => 'Label', | ||
'expected' => array(), | ||
), | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR also allows the
aria-label
attribute by default in theget_block_wrapper_attributes
function, otherwise blocks that have this support would need to explicitly specify the additional attribute, like so: