123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549 |
- <?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
- * @since 6.1.0 Added `$block_spacing` param, use style engine to enqueue styles.
- * @access private
- *
- * @param string $selector CSS selector.
- * @param array $layout Layout object. The one that is passed has already checked
- * the existence of default block layout.
- * @param bool $has_block_gap_support Optional. Whether the theme has support for the block gap. Default false.
- * @param string|string[]|null $gap_value Optional. The block gap value to apply. Default null.
- * @param bool $should_skip_gap_serialization Optional. Whether to skip applying the user-defined value set in the editor. Default false.
- * @param string $fallback_gap_value Optional. The block gap value to apply. Default '0.5em'.
- * @param array|null $block_spacing Optional. Custom spacing set on the block. Default null.
- * @return string CSS styles on success. Else, empty string.
- */
- function wp_get_layout_style( $selector, $layout, $has_block_gap_support = false, $gap_value = null, $should_skip_gap_serialization = false, $fallback_gap_value = '0.5em', $block_spacing = null ) {
- $layout_type = isset( $layout['type'] ) ? $layout['type'] : 'default';
- $layout_styles = array();
- if ( 'default' === $layout_type ) {
- if ( $has_block_gap_support ) {
- if ( is_array( $gap_value ) ) {
- $gap_value = isset( $gap_value['top'] ) ? $gap_value['top'] : null;
- }
- if ( null !== $gap_value && ! $should_skip_gap_serialization ) {
- // Get spacing CSS variable from preset value if provided.
- if ( is_string( $gap_value ) && str_contains( $gap_value, 'var:preset|spacing|' ) ) {
- $index_to_splice = strrpos( $gap_value, '|' ) + 1;
- $slug = _wp_to_kebab_case( substr( $gap_value, $index_to_splice ) );
- $gap_value = "var(--wp--preset--spacing--$slug)";
- }
- array_push(
- $layout_styles,
- array(
- 'selector' => "$selector > *",
- 'declarations' => array(
- 'margin-block-start' => '0',
- 'margin-block-end' => '0',
- ),
- ),
- array(
- 'selector' => "$selector$selector > * + *",
- 'declarations' => array(
- 'margin-block-start' => $gap_value,
- 'margin-block-end' => '0',
- ),
- )
- );
- }
- }
- } elseif ( 'constrained' === $layout_type ) {
- $content_size = isset( $layout['contentSize'] ) ? $layout['contentSize'] : '';
- $wide_size = isset( $layout['wideSize'] ) ? $layout['wideSize'] : '';
- $justify_content = isset( $layout['justifyContent'] ) ? $layout['justifyContent'] : 'center';
- $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.
- $all_max_width_value = safecss_filter_attr( explode( ';', $all_max_width_value )[0] );
- $wide_max_width_value = safecss_filter_attr( explode( ';', $wide_max_width_value )[0] );
- $margin_left = 'left' === $justify_content ? '0 !important' : 'auto !important';
- $margin_right = 'right' === $justify_content ? '0 !important' : 'auto !important';
- if ( $content_size || $wide_size ) {
- array_push(
- $layout_styles,
- array(
- 'selector' => "$selector > :where(:not(.alignleft):not(.alignright):not(.alignfull))",
- 'declarations' => array(
- 'max-width' => $all_max_width_value,
- 'margin-left' => $margin_left,
- 'margin-right' => $margin_right,
- ),
- ),
- array(
- 'selector' => "$selector > .alignwide",
- 'declarations' => array( 'max-width' => $wide_max_width_value ),
- ),
- array(
- 'selector' => "$selector .alignfull",
- 'declarations' => array( 'max-width' => 'none' ),
- )
- );
- if ( isset( $block_spacing ) ) {
- $block_spacing_values = wp_style_engine_get_styles(
- array(
- 'spacing' => $block_spacing,
- )
- );
- /*
- * Handle negative margins for alignfull children of blocks with custom padding set.
- * They're added separately because padding might only be set on one side.
- */
- if ( isset( $block_spacing_values['declarations']['padding-right'] ) ) {
- $padding_right = $block_spacing_values['declarations']['padding-right'];
- $layout_styles[] = array(
- 'selector' => "$selector > .alignfull",
- 'declarations' => array( 'margin-right' => "calc($padding_right * -1)" ),
- );
- }
- if ( isset( $block_spacing_values['declarations']['padding-left'] ) ) {
- $padding_left = $block_spacing_values['declarations']['padding-left'];
- $layout_styles[] = array(
- 'selector' => "$selector > .alignfull",
- 'declarations' => array( 'margin-left' => "calc($padding_left * -1)" ),
- );
- }
- }
- }
- if ( 'left' === $justify_content ) {
- $layout_styles[] = array(
- 'selector' => "$selector > :where(:not(.alignleft):not(.alignright):not(.alignfull))",
- 'declarations' => array( 'margin-left' => '0 !important' ),
- );
- }
- if ( 'right' === $justify_content ) {
- $layout_styles[] = array(
- 'selector' => "$selector > :where(:not(.alignleft):not(.alignright):not(.alignfull))",
- 'declarations' => array( 'margin-right' => '0 !important' ),
- );
- }
- if ( $has_block_gap_support ) {
- if ( is_array( $gap_value ) ) {
- $gap_value = isset( $gap_value['top'] ) ? $gap_value['top'] : null;
- }
- if ( null !== $gap_value && ! $should_skip_gap_serialization ) {
- // Get spacing CSS variable from preset value if provided.
- if ( is_string( $gap_value ) && str_contains( $gap_value, 'var:preset|spacing|' ) ) {
- $index_to_splice = strrpos( $gap_value, '|' ) + 1;
- $slug = _wp_to_kebab_case( substr( $gap_value, $index_to_splice ) );
- $gap_value = "var(--wp--preset--spacing--$slug)";
- }
- array_push(
- $layout_styles,
- array(
- 'selector' => "$selector > *",
- 'declarations' => array(
- 'margin-block-start' => '0',
- 'margin-block-end' => '0',
- ),
- ),
- array(
- 'selector' => "$selector$selector > * + *",
- 'declarations' => array(
- 'margin-block-start' => $gap_value,
- 'margin-block-end' => '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',
- );
- $vertical_alignment_options = array(
- 'top' => 'flex-start',
- 'center' => 'center',
- 'bottom' => 'flex-end',
- );
- if ( 'horizontal' === $layout_orientation ) {
- $justify_content_options += array( 'space-between' => 'space-between' );
- }
- if ( ! empty( $layout['flexWrap'] ) && 'nowrap' === $layout['flexWrap'] ) {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'flex-wrap' => 'nowrap' ),
- );
- }
- if ( $has_block_gap_support && isset( $gap_value ) ) {
- $combined_gap_value = '';
- $gap_sides = is_array( $gap_value ) ? array( 'top', 'left' ) : array( 'top' );
- foreach ( $gap_sides as $gap_side ) {
- $process_value = is_string( $gap_value ) ? $gap_value : _wp_array_get( $gap_value, array( $gap_side ), $fallback_gap_value );
- // Get spacing CSS variable from preset value if provided.
- if ( is_string( $process_value ) && str_contains( $process_value, 'var:preset|spacing|' ) ) {
- $index_to_splice = strrpos( $process_value, '|' ) + 1;
- $slug = _wp_to_kebab_case( substr( $process_value, $index_to_splice ) );
- $process_value = "var(--wp--preset--spacing--$slug)";
- }
- $combined_gap_value .= "$process_value ";
- }
- $gap_value = trim( $combined_gap_value );
- if ( null !== $gap_value && ! $should_skip_gap_serialization ) {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'gap' => $gap_value ),
- );
- }
- }
- if ( 'horizontal' === $layout_orientation ) {
- /*
- * 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 ) ) {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'justify-content' => $justify_content_options[ $layout['justifyContent'] ] ),
- );
- }
- if ( ! empty( $layout['verticalAlignment'] ) && array_key_exists( $layout['verticalAlignment'], $vertical_alignment_options ) ) {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'align-items' => $vertical_alignment_options[ $layout['verticalAlignment'] ] ),
- );
- }
- } else {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'flex-direction' => 'column' ),
- );
- if ( ! empty( $layout['justifyContent'] ) && array_key_exists( $layout['justifyContent'], $justify_content_options ) ) {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'align-items' => $justify_content_options[ $layout['justifyContent'] ] ),
- );
- } else {
- $layout_styles[] = array(
- 'selector' => $selector,
- 'declarations' => array( 'align-items' => 'flex-start' ),
- );
- }
- }
- }
- if ( ! empty( $layout_styles ) ) {
- /*
- * Add to the style engine store to enqueue and render layout styles.
- * Return compiled layout styles to retain backwards compatibility.
- * Since https://github.com/WordPress/gutenberg/pull/42452,
- * wp_enqueue_block_support_styles is no longer called in this block supports file.
- */
- return wp_style_engine_get_stylesheet_from_css_rules(
- $layout_styles,
- array(
- 'context' => 'block-supports',
- 'prettify' => false,
- )
- );
- }
- return '';
- }
- /**
- * 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' ) );
- $global_layout_settings = 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 ( ! $global_layout_settings ) {
- return $block_content;
- }
- }
- $class_names = array();
- $layout_definitions = _wp_array_get( $global_layout_settings, array( 'definitions' ), array() );
- $block_classname = wp_get_block_default_classname( $block['blockName'] );
- $container_class = wp_unique_id( 'wp-container-' );
- $layout_classname = '';
- // Set the correct layout type for blocks using legacy content width.
- if ( isset( $used_layout['inherit'] ) && $used_layout['inherit'] || isset( $used_layout['contentSize'] ) && $used_layout['contentSize'] ) {
- $used_layout['type'] = 'constrained';
- }
- if (
- wp_get_global_settings( array( 'useRootPaddingAwareAlignments' ) ) &&
- isset( $used_layout['type'] ) &&
- 'constrained' === $used_layout['type']
- ) {
- $class_names[] = 'has-global-padding';
- }
- /*
- * The following section was added to reintroduce a small set of layout classnames that were
- * removed in the 5.9 release (https://github.com/WordPress/gutenberg/issues/38719). It is
- * not intended to provide an extended set of classes to match all block layout attributes
- * here.
- */
- if ( ! empty( $block['attrs']['layout']['orientation'] ) ) {
- $class_names[] = 'is-' . sanitize_title( $block['attrs']['layout']['orientation'] );
- }
- if ( ! empty( $block['attrs']['layout']['justifyContent'] ) ) {
- $class_names[] = 'is-content-justification-' . sanitize_title( $block['attrs']['layout']['justifyContent'] );
- }
- if ( ! empty( $block['attrs']['layout']['flexWrap'] ) && 'nowrap' === $block['attrs']['layout']['flexWrap'] ) {
- $class_names[] = 'is-nowrap';
- }
- // Get classname for layout type.
- if ( isset( $used_layout['type'] ) ) {
- $layout_classname = _wp_array_get( $layout_definitions, array( $used_layout['type'], 'className' ), '' );
- } else {
- $layout_classname = _wp_array_get( $layout_definitions, array( 'default', 'className' ), '' );
- }
- if ( $layout_classname && is_string( $layout_classname ) ) {
- $class_names[] = sanitize_title( $layout_classname );
- }
- /*
- * Only generate Layout styles if the theme has not opted-out.
- * Attribute-based Layout classnames are output in all cases.
- */
- if ( ! current_theme_supports( 'disable-layout-styles' ) ) {
- $gap_value = _wp_array_get( $block, array( 'attrs', 'style', 'spacing', 'blockGap' ) );
- /*
- * Skip if gap value contains unsupported characters.
- * Regex for CSS value borrowed from `safecss_filter_attr`, and used here
- * to only match against the value, not the CSS attribute.
- */
- if ( is_array( $gap_value ) ) {
- foreach ( $gap_value as $key => $value ) {
- $gap_value[ $key ] = $value && preg_match( '%[\\\(&=}]|/\*%', $value ) ? null : $value;
- }
- } else {
- $gap_value = $gap_value && preg_match( '%[\\\(&=}]|/\*%', $gap_value ) ? null : $gap_value;
- }
- $fallback_gap_value = _wp_array_get( $block_type->supports, array( 'spacing', 'blockGap', '__experimentalDefault' ), '0.5em' );
- $block_spacing = _wp_array_get( $block, array( 'attrs', 'style', 'spacing' ), null );
- /*
- * If a block's block.json skips serialization for spacing or spacing.blockGap,
- * don't apply the user-defined value to the styles.
- */
- $should_skip_gap_serialization = wp_should_skip_block_supports_serialization( $block_type, 'spacing', 'blockGap' );
- $style = wp_get_layout_style(
- ".$block_classname.$container_class",
- $used_layout,
- $has_block_gap_support,
- $gap_value,
- $should_skip_gap_serialization,
- $fallback_gap_value,
- $block_spacing
- );
- // Only add container class and enqueue block support styles if unique styles were generated.
- if ( ! empty( $style ) ) {
- $class_names[] = $container_class;
- }
- }
- /*
- * This assumes the hook only applies to blocks with a single wrapper.
- * A limitation of this hook is that nested inner blocks wrappers are not yet supported.
- */
- $content = preg_replace(
- '/' . preg_quote( 'class="', '/' ) . '/',
- 'class="' . esc_attr( implode( ' ', $class_names ) ) . ' ',
- $block_content,
- 1
- );
- 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 (
- WP_Theme_JSON_Resolver::theme_has_support() ||
- 1 === preg_match( $group_with_inner_container_regex, $block_content ) ||
- ( isset( $block['attrs']['layout']['type'] ) && 'flex' === $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_core/group', 'wp_restore_group_inner_container', 10, 2 );
- /**
- * For themes without theme.json file, make sure
- * to restore the outer div for the aligned image block
- * to avoid breaking styles relying on that div.
- *
- * @since 6.0.0
- * @access private
- *
- * @param string $block_content Rendered block content.
- * @param array $block Block object.
- * @return string Filtered block content.
- */
- function wp_restore_image_outer_container( $block_content, $block ) {
- $image_with_align = "
- /# 1) everything up to the class attribute contents
- (
- ^\s*
- <figure\b
- [^>]*
- \bclass=
- [\"']
- )
- # 2) the class attribute contents
- (
- [^\"']*
- \bwp-block-image\b
- [^\"']*
- \b(?:alignleft|alignright|aligncenter)\b
- [^\"']*
- )
- # 3) everything after the class attribute contents
- (
- [\"']
- [^>]*
- >
- .*
- <\/figure>
- )/iUx";
- if (
- WP_Theme_JSON_Resolver::theme_has_support() ||
- 0 === preg_match( $image_with_align, $block_content, $matches )
- ) {
- return $block_content;
- }
- $wrapper_classnames = array( 'wp-block-image' );
- // If the block has a classNames attribute these classnames need to be removed from the content and added back
- // to the new wrapper div also.
- if ( ! empty( $block['attrs']['className'] ) ) {
- $wrapper_classnames = array_merge( $wrapper_classnames, explode( ' ', $block['attrs']['className'] ) );
- }
- $content_classnames = explode( ' ', $matches[2] );
- $filtered_content_classnames = array_diff( $content_classnames, $wrapper_classnames );
- return '<div class="' . implode( ' ', $wrapper_classnames ) . '">' . $matches[1] . implode( ' ', $filtered_content_classnames ) . $matches[3] . '</div>';
- }
- add_filter( 'render_block_core/image', 'wp_restore_image_outer_container', 10, 2 );
|