vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Editor: svn add new files missed in [55285].

Browse Source 
Follow-up to [55285].

See #57618.

git-svn-id: https://develop.svn.wordpress.org/trunk@55286 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
David Baumwald
2023-02-07 18:09:44 +00:00
parent f7c2299a0e
commit 6ae5afcfaf
2 changed files with 337 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

151
src/wp-includes/block-supports/position.php Normal file
View File

@@ -0,0 +1,151 @@
<?php
/**
* Position block support flag.
*
* @package WordPress
* @since 6.2.0
*/
/**
* Registers the style block attribute for block types that support it.
*
* @since 6.2.0
* @access private
*
* @param WP_Block_Type $block_type Block Type.
*/
function wp_register_position_support( $block_type ) {
$has_position_support = block_has_support( $block_type, array( 'position' ), false );
// Set up attributes and styles within that if needed.
if ( ! $block_type->attributes ) {
$block_type->attributes = array();
}
if ( $has_position_support && ! array_key_exists( 'style', $block_type->attributes ) ) {
$block_type->attributes['style'] = array(
'type' => 'object',
);
}
}
/**
* Renders position styles to the block wrapper.
*
* @since 6.2.0
* @access private
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*/
function wp_render_position_support( $block_content, $block ) {
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
$has_position_support = block_has_support( $block_type, array( 'position' ), false );
if (
! $has_position_support ||
empty( $block['attrs']['style']['position'] )
) {
return $block_content;
}
$global_settings = wp_get_global_settings();
$theme_has_sticky_support = _wp_array_get( $global_settings, array( 'position', 'sticky' ), false );
$theme_has_fixed_support = _wp_array_get( $global_settings, array( 'position', 'fixed' ), false );
// Only allow output for position types that the theme supports.
$allowed_position_types = array();
if ( true === $theme_has_sticky_support ) {
$allowed_position_types[] = 'sticky';
}
if ( true === $theme_has_fixed_support ) {
$allowed_position_types[] = 'fixed';
}
$style_attribute = _wp_array_get( $block, array( 'attrs', 'style' ), null );
$class_name = wp_unique_id( 'wp-container-' );
$selector = ".$class_name";
$position_styles = array();
$position_type = _wp_array_get( $style_attribute, array( 'position', 'type' ), '' );
$wrapper_classes = array();
if (
in_array( $position_type, $allowed_position_types, true )
) {
$wrapper_classes[] = $class_name;
$wrapper_classes[] = 'is-position-' . $position_type;
$sides = array( 'top', 'right', 'bottom', 'left' );
foreach ( $sides as $side ) {
$side_value = _wp_array_get( $style_attribute, array( 'position', $side ) );
if ( null !== $side_value ) {
/*
* For fixed or sticky top positions,
* ensure the value includes an offset for the logged in admin bar.
*/
if (
'top' === $side &&
( 'fixed' === $position_type || 'sticky' === $position_type )
) {
// Ensure 0 values can be used in `calc()` calculations.
if ( '0' === $side_value || 0 === $side_value ) {
$side_value = '0px';
}
// Ensure current side value also factors in the height of the logged in admin bar.
$side_value = "calc($side_value + var(--wp-admin--admin-bar--position-offset, 0px))";
}
$position_styles[] =
array(
'selector' => $selector,
'declarations' => array(
$side => $side_value,
),
);
}
}
$position_styles[] =
array(
'selector' => $selector,
'declarations' => array(
'position' => $position_type,
'z-index' => '10',
),
);
}
if ( ! empty( $position_styles ) ) {
/*
* Add to the style engine store to enqueue and render position styles.
*/
wp_style_engine_get_stylesheet_from_css_rules(
$position_styles,
array(
'context' => 'block-supports',
'prettify' => false,
)
);
// Inject class name to block container markup.
$content = new WP_HTML_Tag_Processor( $block_content );
$content->next_tag();
foreach ( $wrapper_classes as $class ) {
$content->add_class( $class );
}
return (string) $content;
}
return $block_content;
}
// Register the block support.
WP_Block_Supports::get_instance()->register(
'position',
array(
'register_attribute' => 'wp_register_position_support',
)
);
add_filter( 'render_block', 'wp_render_position_support', 10, 2 );

186
tests/phpunit/tests/block-supports/wpRenderPositionSupport.php Normal file
View File

@@ -0,0 +1,186 @@
<?php
/**
* @group block-supports
*
* @covers ::wp_render_position_support
*/
class Tests_Block_Supports_WpRenderPositionSupport extends WP_UnitTestCase {
/**
* @var string|null
*/
private $test_block_name;
/**
* Theme root directory.
*
* @var string
*/
private $theme_root;
/**
* Original theme directory.
*
* @var string
*/
private $orig_theme_dir;
public function set_up() {
parent::set_up();
$this->test_block_name = null;
$this->theme_root = realpath( DIR_TESTDATA . '/themedir1' );
$this->orig_theme_dir = $GLOBALS['wp_theme_directories'];
// /themes is necessary as theme.php functions assume /themes is the root if there is only one root.
$GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', $this->theme_root );
add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) );
add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
// Clear caches.
wp_clean_themes_cache();
unset( $GLOBALS['wp_themes'] );
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
}
public function tear_down() {
$GLOBALS['wp_theme_directories'] = $this->orig_theme_dir;
// Clear up the filters to modify the theme root.
remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) );
remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
wp_clean_themes_cache();
unset( $GLOBALS['wp_themes'] );
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
unregister_block_type( $this->test_block_name );
$this->test_block_name = null;
parent::tear_down();
}
public function filter_set_theme_root() {
return $this->theme_root;
}
/**
* Tests that position block support works as expected.
*
* @ticket 57618
*
* @covers ::wp_render_position_support
*
* @dataProvider data_position_block_support
*
* @param string $theme_name The theme to switch to.
* @param string $block_name The test block name to register.
* @param mixed $position_settings The position block support settings.
* @param mixed $position_style The position styles within the block attributes.
* @param string $expected_wrapper Expected markup for the block wrapper.
* @param string $expected_styles Expected styles enqueued by the style engine.
*/
public function test_position_block_support( $theme_name, $block_name, $position_settings, $position_style, $expected_wrapper, $expected_styles ) {
switch_theme( $theme_name );
$this->test_block_name = $block_name;
register_block_type(
$this->test_block_name,
array(
'api_version' => 2,
'attributes' => array(
'style' => array(
'type' => 'object',
),
),
'supports' => array(
'position' => $position_settings,
),
)
);
$block = array(
'blockName' => 'test/position-rules-are-output',
'attrs' => array(
'style' => array(
'position' => $position_style,
),
),
);
$actual = wp_render_position_support( '<div>Content</div>', $block );
$this->assertMatchesRegularExpression(
$expected_wrapper,
$actual,
'Position block wrapper markup should be correct'
);
$actual_stylesheet = wp_style_engine_get_stylesheet_from_context(
'block-supports',
array(
'prettify' => false,
)
);
$this->assertMatchesRegularExpression(
$expected_styles,
$actual_stylesheet,
'Position style rules output should be correct'
);
}
/**
* Data provider.
*
* @return array
*/
public function data_position_block_support() {
return array(
'sticky position style is applied' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/position-rules-are-output',
'position_settings' => true,
'position_style' => array(
'type' => 'sticky',
'top' => '0px',
),
'expected_wrapper' => '/^<div class="wp-container-\d+ is-position-sticky">Content<\/div>$/',
'expected_styles' => '/^.wp-container-\d+' . preg_quote( '{top:calc(0px + var(--wp-admin--admin-bar--position-offset, 0px));position:sticky;z-index:10;}' ) . '$/',
),
'sticky position style is not applied if theme does not support it' => array(
'theme_name' => 'default',
'block_name' => 'test/position-rules-without-theme-support',
'position_settings' => true,
'position_style' => array(
'type' => 'sticky',
'top' => '0px',
),
'expected_wrapper' => '/^<div>Content<\/div>$/',
'expected_styles' => '/^$/',
),
'sticky position style is not applied if block does not support it' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/position-rules-without-block-support',
'position_settings' => false,
'position_style' => array(
'type' => 'sticky',
'top' => '0px',
),
'expected_wrapper' => '/^<div>Content<\/div>$/',
'expected_styles' => '/^$/',
),
'sticky position style is not applied if type is not valid' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/position-rules-with-valid-type',
'position_settings' => true,
'position_style' => array(
'type' => 'illegal-type',
'top' => '0px',
),
'expected_wrapper' => '/^<div>Content<\/div>$/',
'expected_styles' => '/^$/',
),
);
}
}