mirror of
https://github.com/WordPress/WordPress.git
synced 2024-10-30 07:20:01 +01:00
7b3c904f37
As of PHP 8.1, explode() does not permit null as its second argument. This results in warnings being spat out on every page because of a usage of this in wp-includes/block-supports/layout.php. See #53635. Props noisysocks. Built from https://develop.svn.wordpress.org/trunk@52380 git-svn-id: http://core.svn.wordpress.org/trunk@51972 1a063a9b-81f0-0310-95a4-ce76da25c4cd
256 lines
9.1 KiB
PHP
256 lines
9.1 KiB
PHP
<?php
|
|
/**
|
|
* Layout block support flag.
|
|
*
|
|
* @package WordPress
|
|
* @since 5.8.0
|
|
*/
|
|
|
|
/**
|
|
* Registers the layout block attribute for block types that support it.
|
|
*
|
|
* @since 5.8.0
|
|
* @access private
|
|
*
|
|
* @param WP_Block_Type $block_type Block Type.
|
|
*/
|
|
function wp_register_layout_support( $block_type ) {
|
|
$support_layout = block_has_support( $block_type, array( '__experimentalLayout' ), false );
|
|
if ( $support_layout ) {
|
|
if ( ! $block_type->attributes ) {
|
|
$block_type->attributes = array();
|
|
}
|
|
|
|
if ( ! array_key_exists( 'layout', $block_type->attributes ) ) {
|
|
$block_type->attributes['layout'] = array(
|
|
'type' => 'object',
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Generates the CSS corresponding to the provided layout.
|
|
*
|
|
* @since 5.9.0
|
|
* @access private
|
|
*
|
|
* @param string $selector CSS selector.
|
|
* @param array $layout Layout object. The one that is passed has already checked
|
|
* the existance of default block layout.
|
|
* @param bool $has_block_gap_support Whether the theme has support for the block gap.
|
|
* @return string CSS style.
|
|
*/
|
|
function wp_get_layout_style( $selector, $layout, $has_block_gap_support = false ) {
|
|
$layout_type = isset( $layout['type'] ) ? $layout['type'] : 'default';
|
|
|
|
$style = '';
|
|
if ( 'default' === $layout_type ) {
|
|
$content_size = isset( $layout['contentSize'] ) ? $layout['contentSize'] : '';
|
|
$wide_size = isset( $layout['wideSize'] ) ? $layout['wideSize'] : '';
|
|
|
|
$all_max_width_value = $content_size ? $content_size : $wide_size;
|
|
$wide_max_width_value = $wide_size ? $wide_size : $content_size;
|
|
|
|
// Make sure there is a single CSS rule, and all tags are stripped for security.
|
|
// TODO: Use `safecss_filter_attr` instead - once https://core.trac.wordpress.org/ticket/46197 is patched.
|
|
$all_max_width_value = wp_strip_all_tags( explode( ';', $all_max_width_value )[0] );
|
|
$wide_max_width_value = wp_strip_all_tags( explode( ';', $wide_max_width_value )[0] );
|
|
|
|
$style = '';
|
|
if ( $content_size || $wide_size ) {
|
|
$style = "$selector > * {";
|
|
$style .= 'max-width: ' . esc_html( $all_max_width_value ) . ';';
|
|
$style .= 'margin-left: auto !important;';
|
|
$style .= 'margin-right: auto !important;';
|
|
$style .= '}';
|
|
|
|
$style .= "$selector > .alignwide { max-width: " . esc_html( $wide_max_width_value ) . ';}';
|
|
$style .= "$selector .alignfull { max-width: none; }";
|
|
}
|
|
|
|
$style .= "$selector .alignleft { float: left; margin-right: 2em; }";
|
|
$style .= "$selector .alignright { float: right; margin-left: 2em; }";
|
|
if ( $has_block_gap_support ) {
|
|
$style .= "$selector > * { margin-top: 0; margin-bottom: 0; }";
|
|
$style .= "$selector > * + * { margin-top: var( --wp--style--block-gap ); margin-bottom: 0; }";
|
|
}
|
|
} elseif ( 'flex' === $layout_type ) {
|
|
$layout_orientation = isset( $layout['orientation'] ) ? $layout['orientation'] : 'horizontal';
|
|
|
|
$justify_content_options = array(
|
|
'left' => 'flex-start',
|
|
'right' => 'flex-end',
|
|
'center' => 'center',
|
|
);
|
|
|
|
if ( 'horizontal' === $layout_orientation ) {
|
|
$justify_content_options += array( 'space-between' => 'space-between' );
|
|
}
|
|
|
|
$flex_wrap_options = array( 'wrap', 'nowrap' );
|
|
$flex_wrap = ! empty( $layout['flexWrap'] ) && in_array( $layout['flexWrap'], $flex_wrap_options, true ) ?
|
|
$layout['flexWrap'] :
|
|
'wrap';
|
|
|
|
$style = "$selector {";
|
|
$style .= 'display: flex;';
|
|
if ( $has_block_gap_support ) {
|
|
$style .= 'gap: var( --wp--style--block-gap, 0.5em );';
|
|
} else {
|
|
$style .= 'gap: 0.5em;';
|
|
}
|
|
$style .= "flex-wrap: $flex_wrap;";
|
|
$style .= 'align-items: center;';
|
|
if ( 'horizontal' === $layout_orientation ) {
|
|
$style .= 'align-items: center;';
|
|
if ( ! empty( $layout['setCascadingProperties'] ) && $layout['setCascadingProperties'] ) {
|
|
$style .= '--layout-direction: row;';
|
|
}
|
|
/**
|
|
* Add this style only if is not empty for backwards compatibility,
|
|
* since we intend to convert blocks that had flex layout implemented
|
|
* by custom css.
|
|
*/
|
|
if ( ! empty( $layout['justifyContent'] ) && array_key_exists( $layout['justifyContent'], $justify_content_options ) ) {
|
|
$style .= "justify-content: {$justify_content_options[ $layout['justifyContent'] ]};";
|
|
if ( ! empty( $layout['setCascadingProperties'] ) && $layout['setCascadingProperties'] ) {
|
|
// --layout-justification-setting allows children to inherit the value regardless or row or column direction.
|
|
$style .= "--layout-justification-setting: {$justify_content_options[ $layout['justifyContent'] ]};";
|
|
$style .= "--layout-wrap: $flex_wrap;";
|
|
$style .= "--layout-justify: {$justify_content_options[ $layout['justifyContent'] ]};";
|
|
$style .= '--layout-align: center;';
|
|
}
|
|
}
|
|
} else {
|
|
$style .= 'flex-direction: column;';
|
|
if ( ! empty( $layout['justifyContent'] ) && array_key_exists( $layout['justifyContent'], $justify_content_options ) ) {
|
|
$style .= "align-items: {$justify_content_options[ $layout['justifyContent'] ]};";
|
|
if ( ! empty( $layout['setCascadingProperties'] ) && $layout['setCascadingProperties'] ) {
|
|
$style .= '--layout-direction: column;';
|
|
}
|
|
if ( ! empty( $layout['setCascadingProperties'] ) && $layout['setCascadingProperties'] ) {
|
|
// --layout-justification-setting allows children to inherit the value regardless or row or column direction.
|
|
$style .= "--layout-justification-setting: {$justify_content_options[ $layout['justifyContent'] ]};";
|
|
$style .= '--layout-justify: initial;';
|
|
$style .= "--layout-align: {$justify_content_options[ $layout['justifyContent'] ]};";
|
|
}
|
|
}
|
|
}
|
|
$style .= '}';
|
|
|
|
$style .= "$selector > * { margin: 0; }";
|
|
}
|
|
|
|
return $style;
|
|
}
|
|
|
|
/**
|
|
* Renders the layout config to the block wrapper.
|
|
*
|
|
* @since 5.8.0
|
|
* @access private
|
|
*
|
|
* @param string $block_content Rendered block content.
|
|
* @param array $block Block object.
|
|
* @return string Filtered block content.
|
|
*/
|
|
function wp_render_layout_support_flag( $block_content, $block ) {
|
|
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
|
|
$support_layout = block_has_support( $block_type, array( '__experimentalLayout' ), false );
|
|
|
|
if ( ! $support_layout ) {
|
|
return $block_content;
|
|
}
|
|
|
|
$block_gap = wp_get_global_settings( array( 'spacing', 'blockGap' ) );
|
|
$default_layout = wp_get_global_settings( array( 'layout' ) );
|
|
$has_block_gap_support = isset( $block_gap ) ? null !== $block_gap : false;
|
|
$default_block_layout = _wp_array_get( $block_type->supports, array( '__experimentalLayout', 'default' ), array() );
|
|
$used_layout = isset( $block['attrs']['layout'] ) ? $block['attrs']['layout'] : $default_block_layout;
|
|
if ( isset( $used_layout['inherit'] ) && $used_layout['inherit'] ) {
|
|
if ( ! $default_layout ) {
|
|
return $block_content;
|
|
}
|
|
$used_layout = $default_layout;
|
|
}
|
|
|
|
$id = uniqid();
|
|
$style = wp_get_layout_style( ".wp-container-$id", $used_layout, $has_block_gap_support );
|
|
// This assumes the hook only applies to blocks with a single wrapper.
|
|
// I think this is a reasonable limitation for that particular hook.
|
|
$content = preg_replace(
|
|
'/' . preg_quote( 'class="', '/' ) . '/',
|
|
'class="wp-container-' . $id . ' ',
|
|
$block_content,
|
|
1
|
|
);
|
|
|
|
/*
|
|
* Ideally styles should be loaded in the head, but blocks may be parsed
|
|
* after that, so loading in the footer for now.
|
|
* See https://core.trac.wordpress.org/ticket/53494.
|
|
*/
|
|
add_action(
|
|
'wp_footer',
|
|
static function () use ( $style ) {
|
|
echo '<style>' . $style . '</style>';
|
|
}
|
|
);
|
|
|
|
return $content;
|
|
}
|
|
|
|
// Register the block support.
|
|
WP_Block_Supports::get_instance()->register(
|
|
'layout',
|
|
array(
|
|
'register_attribute' => 'wp_register_layout_support',
|
|
)
|
|
);
|
|
add_filter( 'render_block', 'wp_render_layout_support_flag', 10, 2 );
|
|
|
|
/**
|
|
* For themes without theme.json file, make sure
|
|
* to restore the inner div for the group block
|
|
* to avoid breaking styles relying on that div.
|
|
*
|
|
* @since 5.8.0
|
|
* @access private
|
|
*
|
|
* @param string $block_content Rendered block content.
|
|
* @param array $block Block object.
|
|
* @return string Filtered block content.
|
|
*/
|
|
function wp_restore_group_inner_container( $block_content, $block ) {
|
|
$tag_name = isset( $block['attrs']['tagName'] ) ? $block['attrs']['tagName'] : 'div';
|
|
$group_with_inner_container_regex = sprintf(
|
|
'/(^\s*<%1$s\b[^>]*wp-block-group(\s|")[^>]*>)(\s*<div\b[^>]*wp-block-group__inner-container(\s|")[^>]*>)((.|\S|\s)*)/U',
|
|
preg_quote( $tag_name, '/' )
|
|
);
|
|
|
|
if (
|
|
'core/group' !== $block['blockName'] ||
|
|
WP_Theme_JSON_Resolver::theme_has_support() ||
|
|
1 === preg_match( $group_with_inner_container_regex, $block_content ) ||
|
|
( isset( $block['attrs']['layout']['type'] ) && 'default' !== $block['attrs']['layout']['type'] )
|
|
) {
|
|
return $block_content;
|
|
}
|
|
|
|
$replace_regex = sprintf(
|
|
'/(^\s*<%1$s\b[^>]*wp-block-group[^>]*>)(.*)(<\/%1$s>\s*$)/ms',
|
|
preg_quote( $tag_name, '/' )
|
|
);
|
|
$updated_content = preg_replace_callback(
|
|
$replace_regex,
|
|
static function( $matches ) {
|
|
return $matches[1] . '<div class="wp-block-group__inner-container">' . $matches[2] . '</div>' . $matches[3];
|
|
},
|
|
$block_content
|
|
);
|
|
return $updated_content;
|
|
}
|
|
|
|
add_filter( 'render_block', 'wp_restore_group_inner_container', 10, 2 );
|