mirror of
https://github.com/WordPress/WordPress.git
synced 2024-09-16 01:27:02 +02:00
dc3ffcbde3
Update packages to include these bug fixes from Gutenberg: - Include cascading properties in Navigation deprecation - Reorganize e2e tests folders and file - Border panel: Update to display multiple palette origins - Add CSS fix for 33580 - Add: Uneditable duotone palette on the palette gradient panel - Site Editor: Allow editing custom template title - Writing Flow: Double escape unselects all blocks - Fix icon scaling. - [Block Library - Query Pagination Next/Previous]: Remove text and link color support - Add: Border indication to global styles colors. - Color Picker: Improve border, padding, and box shadow styles. - theme.json: sort keys alphabetically - Remove navigationArea context. See #54487. Built from https://develop.svn.wordpress.org/trunk@52277 git-svn-id: http://core.svn.wordpress.org/trunk@51869 1a063a9b-81f0-0310-95a4-ce76da25c4cd
477 lines
18 KiB
PHP
477 lines
18 KiB
PHP
<?php
|
|
/**
|
|
* Server-side rendering of the `core/navigation` block.
|
|
*
|
|
* @package WordPress
|
|
*/
|
|
|
|
/**
|
|
* Build an array with CSS classes and inline styles defining the colors
|
|
* which will be applied to the navigation markup in the front-end.
|
|
*
|
|
* @param array $attributes Navigation block attributes.
|
|
*
|
|
* @return array Colors CSS classes and inline styles.
|
|
*/
|
|
function block_core_navigation_build_css_colors( $attributes ) {
|
|
$colors = array(
|
|
'css_classes' => array(),
|
|
'inline_styles' => '',
|
|
'overlay_css_classes' => array(),
|
|
'overlay_inline_styles' => '',
|
|
);
|
|
|
|
// Text color.
|
|
$has_named_text_color = array_key_exists( 'textColor', $attributes );
|
|
$has_custom_text_color = array_key_exists( 'customTextColor', $attributes );
|
|
|
|
// If has text color.
|
|
if ( $has_custom_text_color || $has_named_text_color ) {
|
|
// Add has-text-color class.
|
|
$colors['css_classes'][] = 'has-text-color';
|
|
}
|
|
|
|
if ( $has_named_text_color ) {
|
|
// Add the color class.
|
|
$colors['css_classes'][] = sprintf( 'has-%s-color', $attributes['textColor'] );
|
|
} elseif ( $has_custom_text_color ) {
|
|
// Add the custom color inline style.
|
|
$colors['inline_styles'] .= sprintf( 'color: %s;', $attributes['customTextColor'] );
|
|
}
|
|
|
|
// Background color.
|
|
$has_named_background_color = array_key_exists( 'backgroundColor', $attributes );
|
|
$has_custom_background_color = array_key_exists( 'customBackgroundColor', $attributes );
|
|
|
|
// If has background color.
|
|
if ( $has_custom_background_color || $has_named_background_color ) {
|
|
// Add has-background class.
|
|
$colors['css_classes'][] = 'has-background';
|
|
}
|
|
|
|
if ( $has_named_background_color ) {
|
|
// Add the background-color class.
|
|
$colors['css_classes'][] = sprintf( 'has-%s-background-color', $attributes['backgroundColor'] );
|
|
} elseif ( $has_custom_background_color ) {
|
|
// Add the custom background-color inline style.
|
|
$colors['inline_styles'] .= sprintf( 'background-color: %s;', $attributes['customBackgroundColor'] );
|
|
}
|
|
|
|
// Overlay text color.
|
|
$has_named_overlay_text_color = array_key_exists( 'overlayTextColor', $attributes );
|
|
$has_custom_overlay_text_color = array_key_exists( 'customOverlayTextColor', $attributes );
|
|
|
|
// If has overlay text color.
|
|
if ( $has_custom_overlay_text_color || $has_named_overlay_text_color ) {
|
|
// Add has-text-color class.
|
|
$colors['overlay_css_classes'][] = 'has-text-color';
|
|
}
|
|
|
|
if ( $has_named_overlay_text_color ) {
|
|
// Add the overlay color class.
|
|
$colors['overlay_css_classes'][] = sprintf( 'has-%s-color', $attributes['overlayTextColor'] );
|
|
} elseif ( $has_custom_overlay_text_color ) {
|
|
// Add the custom overlay color inline style.
|
|
$colors['overlay_inline_styles'] .= sprintf( 'color: %s;', $attributes['customOverlayTextColor'] );
|
|
}
|
|
|
|
// Overlay background color.
|
|
$has_named_overlay_background_color = array_key_exists( 'overlayBackgroundColor', $attributes );
|
|
$has_custom_overlay_background_color = array_key_exists( 'customOverlayBackgroundColor', $attributes );
|
|
|
|
// If has overlay background color.
|
|
if ( $has_custom_overlay_background_color || $has_named_overlay_background_color ) {
|
|
// Add has-background class.
|
|
$colors['overlay_css_classes'][] = 'has-background';
|
|
}
|
|
|
|
if ( $has_named_overlay_background_color ) {
|
|
// Add the overlay background-color class.
|
|
$colors['overlay_css_classes'][] = sprintf( 'has-%s-background-color', $attributes['overlayBackgroundColor'] );
|
|
} elseif ( $has_custom_overlay_background_color ) {
|
|
// Add the custom overlay background-color inline style.
|
|
$colors['overlay_inline_styles'] .= sprintf( 'background-color: %s;', $attributes['customOverlayBackgroundColor'] );
|
|
}
|
|
|
|
return $colors;
|
|
}
|
|
|
|
/**
|
|
* Build an array with CSS classes and inline styles defining the font sizes
|
|
* which will be applied to the navigation markup in the front-end.
|
|
*
|
|
* @param array $attributes Navigation block attributes.
|
|
*
|
|
* @return array Font size CSS classes and inline styles.
|
|
*/
|
|
function block_core_navigation_build_css_font_sizes( $attributes ) {
|
|
// CSS classes.
|
|
$font_sizes = array(
|
|
'css_classes' => array(),
|
|
'inline_styles' => '',
|
|
);
|
|
|
|
$has_named_font_size = array_key_exists( 'fontSize', $attributes );
|
|
$has_custom_font_size = array_key_exists( 'customFontSize', $attributes );
|
|
|
|
if ( $has_named_font_size ) {
|
|
// Add the font size class.
|
|
$font_sizes['css_classes'][] = sprintf( 'has-%s-font-size', $attributes['fontSize'] );
|
|
} elseif ( $has_custom_font_size ) {
|
|
// Add the custom font size inline style.
|
|
$font_sizes['inline_styles'] = sprintf( 'font-size: %spx;', $attributes['customFontSize'] );
|
|
}
|
|
|
|
return $font_sizes;
|
|
}
|
|
|
|
/**
|
|
* Returns the top-level submenu SVG chevron icon.
|
|
*
|
|
* @return string
|
|
*/
|
|
function block_core_navigation_render_submenu_icon() {
|
|
return '<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none" role="img" aria-hidden="true" focusable="false"><path d="M1.50002 4L6.00002 8L10.5 4" stroke-width="1.5"></path></svg>';
|
|
}
|
|
|
|
|
|
/**
|
|
* Finds the first non-empty `wp_navigation` Post.
|
|
*
|
|
* @return WP_Post|null the first non-empty Navigation or null.
|
|
*/
|
|
function block_core_navigation_get_first_non_empty_navigation() {
|
|
// Order and orderby args set to mirror those in `wp_get_nav_menus`
|
|
// see:
|
|
// - https://github.com/WordPress/wordpress-develop/blob/ba943e113d3b31b121f77a2d30aebe14b047c69d/src/wp-includes/nav-menu.php#L613-L619.
|
|
// - https://developer.wordpress.org/reference/classes/wp_query/#order-orderby-parameters.
|
|
$navigation_posts = get_posts(
|
|
array(
|
|
'post_type' => 'wp_navigation',
|
|
'order' => 'ASC',
|
|
'orderby' => 'name',
|
|
'posts_per_page' => 1, // only the first post.
|
|
's' => '<!-- wp:', // look for block indicators to ensure we only include non-empty Navigations.
|
|
)
|
|
);
|
|
return count( $navigation_posts ) ? $navigation_posts[0] : null;
|
|
|
|
}
|
|
|
|
/**
|
|
* Filter out empty "null" blocks from the block list.
|
|
* 'parse_blocks' includes a null block with '\n\n' as the content when
|
|
* it encounters whitespace. This is not a bug but rather how the parser
|
|
* is designed.
|
|
*
|
|
* @param array $parsed_blocks the parsed blocks to be normalized.
|
|
* @return array the normalized parsed blocks.
|
|
*/
|
|
function block_core_navigation_filter_out_empty_blocks( $parsed_blocks ) {
|
|
$filtered = array_filter(
|
|
$parsed_blocks,
|
|
function( $block ) {
|
|
return isset( $block['blockName'] );
|
|
}
|
|
);
|
|
|
|
// Reset keys.
|
|
return array_values( $filtered );
|
|
}
|
|
|
|
/**
|
|
* Retrieves the appropriate fallback to be used on the front of the
|
|
* site when there is no menu assigned to the Nav block.
|
|
*
|
|
* This aims to mirror how the fallback mechanic for wp_nav_menu works.
|
|
* See https://developer.wordpress.org/reference/functions/wp_nav_menu/#more-information.
|
|
*
|
|
* @return array the array of blocks to be used as a fallback.
|
|
*/
|
|
function block_core_navigation_get_fallback_blocks() {
|
|
$page_list_fallback = array(
|
|
array(
|
|
'blockName' => 'core/page-list',
|
|
'attrs' => array(
|
|
'__unstableMaxPages' => 4,
|
|
),
|
|
),
|
|
);
|
|
|
|
$registry = WP_Block_Type_Registry::get_instance();
|
|
|
|
// If `core/page-list` is not registered then return empty blocks.
|
|
$fallback_blocks = $registry->is_registered( 'core/page-list' ) ? $page_list_fallback : array();
|
|
|
|
// Default to a list of Pages.
|
|
|
|
$navigation_post = block_core_navigation_get_first_non_empty_navigation();
|
|
|
|
// Prefer using the first non-empty Navigation as fallback if available.
|
|
if ( $navigation_post ) {
|
|
$maybe_fallback = block_core_navigation_filter_out_empty_blocks( parse_blocks( $navigation_post->post_content ) );
|
|
|
|
// Normalizing blocks may result in an empty array of blocks if they were all `null` blocks.
|
|
// In this case default to the (Page List) fallback.
|
|
$fallback_blocks = ! empty( $maybe_fallback ) ? $maybe_fallback : $fallback_blocks;
|
|
}
|
|
|
|
/**
|
|
* Filters the fallback experience for the Navigation block.
|
|
*
|
|
* Returning a falsey value will opt out of the fallback and cause the block not to render.
|
|
* To customise the blocks provided return an array of blocks - these should be valid
|
|
* children of the `core/navigation` block.
|
|
*
|
|
* @param array[] default fallback blocks provided by the default block mechanic.
|
|
*/
|
|
return apply_filters( 'block_core_navigation_render_fallback', $fallback_blocks );
|
|
}
|
|
|
|
/**
|
|
* Renders the `core/navigation` block on server.
|
|
*
|
|
* @param array $attributes The block attributes.
|
|
* @param array $content The saved content.
|
|
* @param array $block The parsed block.
|
|
*
|
|
* @return string Returns the post content with the legacy widget added.
|
|
*/
|
|
function render_block_core_navigation( $attributes, $content, $block ) {
|
|
|
|
// Flag used to indicate whether the rendered output is considered to be
|
|
// a fallback (i.e. the block has no menu associated with it).
|
|
$is_fallback = false;
|
|
|
|
/**
|
|
* Deprecated:
|
|
* The rgbTextColor and rgbBackgroundColor attributes
|
|
* have been deprecated in favor of
|
|
* customTextColor and customBackgroundColor ones.
|
|
* Move the values from old attrs to the new ones.
|
|
*/
|
|
if ( isset( $attributes['rgbTextColor'] ) && empty( $attributes['textColor'] ) ) {
|
|
$attributes['customTextColor'] = $attributes['rgbTextColor'];
|
|
}
|
|
|
|
if ( isset( $attributes['rgbBackgroundColor'] ) && empty( $attributes['backgroundColor'] ) ) {
|
|
$attributes['customBackgroundColor'] = $attributes['rgbBackgroundColor'];
|
|
}
|
|
|
|
unset( $attributes['rgbTextColor'], $attributes['rgbBackgroundColor'] );
|
|
|
|
/**
|
|
* This is for backwards compatibility after `isResponsive` attribute has been removed.
|
|
*/
|
|
$has_old_responsive_attribute = ! empty( $attributes['isResponsive'] ) && $attributes['isResponsive'];
|
|
$is_responsive_menu = isset( $attributes['overlayMenu'] ) && 'never' !== $attributes['overlayMenu'] || $has_old_responsive_attribute;
|
|
$should_load_view_script = ! wp_script_is( 'wp-block-navigation-view' ) && ( $is_responsive_menu || $attributes['openSubmenusOnClick'] || $attributes['showSubmenuIcon'] );
|
|
if ( $should_load_view_script ) {
|
|
wp_enqueue_script( 'wp-block-navigation-view' );
|
|
}
|
|
|
|
$inner_blocks = $block->inner_blocks;
|
|
|
|
// If `__unstableLocation` is defined, create inner blocks from the classic menu assigned to that location.
|
|
if ( empty( $inner_blocks ) && array_key_exists( '__unstableLocation', $attributes ) ) {
|
|
$menu_items = gutenberg_get_menu_items_at_location( $attributes['__unstableLocation'] );
|
|
if ( empty( $menu_items ) ) {
|
|
return '';
|
|
}
|
|
|
|
$menu_items_by_parent_id = gutenberg_sort_menu_items_by_parent_id( $menu_items );
|
|
$parsed_blocks = gutenberg_parse_blocks_from_menu_items( $menu_items_by_parent_id[0], $menu_items_by_parent_id );
|
|
$inner_blocks = new WP_Block_List( $parsed_blocks, $attributes );
|
|
}
|
|
|
|
// Ensure that blocks saved with the legacy ref attribute name (navigationMenuId) continue to render.
|
|
if ( array_key_exists( 'navigationMenuId', $attributes ) ) {
|
|
$attributes['ref'] = $attributes['navigationMenuId'];
|
|
}
|
|
// Load inner blocks from the navigation post.
|
|
if ( array_key_exists( 'ref', $attributes ) ) {
|
|
$navigation_post = get_post( $attributes['ref'] );
|
|
if ( ! isset( $navigation_post ) ) {
|
|
return '';
|
|
}
|
|
|
|
$parsed_blocks = parse_blocks( $navigation_post->post_content );
|
|
|
|
// 'parse_blocks' includes a null block with '\n\n' as the content when
|
|
// it encounters whitespace. This code strips it.
|
|
$compacted_blocks = block_core_navigation_filter_out_empty_blocks( $parsed_blocks );
|
|
|
|
// TODO - this uses the full navigation block attributes for the
|
|
// context which could be refined.
|
|
$inner_blocks = new WP_Block_List( $compacted_blocks, $attributes );
|
|
}
|
|
|
|
// If there are no inner blocks then fallback to rendering an appropriate fallback.
|
|
if ( empty( $inner_blocks ) ) {
|
|
$is_fallback = true; // indicate we are rendering the fallback.
|
|
|
|
$fallback_blocks = block_core_navigation_get_fallback_blocks();
|
|
|
|
// Fallback my have been filtered so do basic test for validity.
|
|
if ( empty( $fallback_blocks ) || ! is_array( $fallback_blocks ) ) {
|
|
return '';
|
|
}
|
|
|
|
$inner_blocks = new WP_Block_List( $fallback_blocks, $attributes );
|
|
|
|
}
|
|
|
|
// Restore legacy classnames for submenu positioning.
|
|
$layout_class = '';
|
|
if ( isset( $attributes['layout']['justifyContent'] ) ) {
|
|
if ( 'right' === $attributes['layout']['justifyContent'] ) {
|
|
$layout_class .= 'items-justified-right';
|
|
} elseif ( 'space-between' === $attributes['layout']['justifyContent'] ) {
|
|
$layout_class .= 'items-justified-space-between';
|
|
}
|
|
}
|
|
|
|
$colors = block_core_navigation_build_css_colors( $attributes );
|
|
$font_sizes = block_core_navigation_build_css_font_sizes( $attributes );
|
|
$classes = array_merge(
|
|
$colors['css_classes'],
|
|
$font_sizes['css_classes'],
|
|
$is_responsive_menu ? array( 'is-responsive' ) : array(),
|
|
$layout_class ? array( $layout_class ) : array(),
|
|
$is_fallback ? array( 'is-fallback' ) : array()
|
|
);
|
|
|
|
$inner_blocks_html = '';
|
|
$is_list_open = false;
|
|
foreach ( $inner_blocks as $inner_block ) {
|
|
if ( ( 'core/navigation-link' === $inner_block->name || 'core/home-link' === $inner_block->name || 'core/site-title' === $inner_block->name || 'core/site-logo' === $inner_block->name || 'core/navigation-submenu' === $inner_block->name ) && ! $is_list_open ) {
|
|
$is_list_open = true;
|
|
$inner_blocks_html .= '<ul class="wp-block-navigation__container">';
|
|
}
|
|
if ( 'core/navigation-link' !== $inner_block->name && 'core/home-link' !== $inner_block->name && 'core/site-title' !== $inner_block->name && 'core/site-logo' !== $inner_block->name && 'core/navigation-submenu' !== $inner_block->name && $is_list_open ) {
|
|
$is_list_open = false;
|
|
$inner_blocks_html .= '</ul>';
|
|
}
|
|
if ( 'core/site-title' === $inner_block->name || 'core/site-logo' === $inner_block->name ) {
|
|
$inner_blocks_html .= '<li class="wp-block-navigation-item">' . $inner_block->render() . '</li>';
|
|
} else {
|
|
$inner_blocks_html .= $inner_block->render();
|
|
}
|
|
}
|
|
|
|
if ( $is_list_open ) {
|
|
$inner_blocks_html .= '</ul>';
|
|
}
|
|
|
|
$block_styles = isset( $attributes['styles'] ) ? $attributes['styles'] : '';
|
|
|
|
$wrapper_attributes = get_block_wrapper_attributes(
|
|
array(
|
|
'class' => implode( ' ', $classes ),
|
|
'style' => $block_styles . $colors['inline_styles'] . $font_sizes['inline_styles'],
|
|
)
|
|
);
|
|
|
|
$modal_unique_id = uniqid();
|
|
|
|
// Determine whether or not navigation elements should be wrapped in the markup required to make it responsive,
|
|
// return early if they don't.
|
|
if ( ! $is_responsive_menu ) {
|
|
return sprintf(
|
|
'<nav %1$s>%2$s</nav>',
|
|
$wrapper_attributes,
|
|
$inner_blocks_html
|
|
);
|
|
}
|
|
|
|
$is_hidden_by_default = isset( $attributes['overlayMenu'] ) && 'always' === $attributes['overlayMenu'];
|
|
|
|
$responsive_container_classes = array(
|
|
'wp-block-navigation__responsive-container',
|
|
$is_hidden_by_default ? 'hidden-by-default' : '',
|
|
implode( ' ', $colors['overlay_css_classes'] ),
|
|
);
|
|
$open_button_classes = array(
|
|
'wp-block-navigation__responsive-container-open',
|
|
$is_hidden_by_default ? 'always-shown' : '',
|
|
);
|
|
|
|
$responsive_container_markup = sprintf(
|
|
'<button aria-expanded="false" aria-haspopup="true" aria-label="%3$s" class="%6$s" data-micromodal-trigger="modal-%1$s"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" role="img" aria-hidden="true" focusable="false"><rect x="4" y="7.5" width="16" height="1.5" /><rect x="4" y="15" width="16" height="1.5" /></svg></button>
|
|
<div class="%5$s" style="%7$s" id="modal-%1$s">
|
|
<div class="wp-block-navigation__responsive-close" tabindex="-1" data-micromodal-close>
|
|
<div class="wp-block-navigation__responsive-dialog" role="dialog" aria-modal="true" aria-labelledby="modal-%1$s-title" >
|
|
<button aria-label="%4$s" data-micromodal-close class="wp-block-navigation__responsive-container-close"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" role="img" aria-hidden="true" focusable="false"><path d="M13 11.8l6.1-6.3-1-1-6.1 6.2-6.1-6.2-1 1 6.1 6.3-6.5 6.7 1 1 6.5-6.6 6.5 6.6 1-1z"></path></svg></button>
|
|
<div class="wp-block-navigation__responsive-container-content" id="modal-%1$s-content">
|
|
%2$s
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>',
|
|
$modal_unique_id,
|
|
$inner_blocks_html,
|
|
__( 'Open menu' ), // Open button label.
|
|
__( 'Close menu' ), // Close button label.
|
|
implode( ' ', $responsive_container_classes ),
|
|
implode( ' ', $open_button_classes ),
|
|
$colors['overlay_inline_styles']
|
|
);
|
|
|
|
return sprintf(
|
|
'<nav %1$s>%2$s</nav>',
|
|
$wrapper_attributes,
|
|
$responsive_container_markup
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Register the navigation block.
|
|
*
|
|
* @throws WP_Error An WP_Error exception parsing the block definition.
|
|
* @uses render_block_core_navigation()
|
|
*/
|
|
function register_block_core_navigation() {
|
|
register_block_type_from_metadata(
|
|
__DIR__ . '/navigation',
|
|
array(
|
|
'render_callback' => 'render_block_core_navigation',
|
|
)
|
|
);
|
|
}
|
|
|
|
add_action( 'init', 'register_block_core_navigation' );
|
|
|
|
/**
|
|
* Filter that changes the parsed attribute values of navigation blocks contain typographic presets to contain the values directly.
|
|
*
|
|
* @param array $parsed_block The block being rendered.
|
|
*
|
|
* @return array The block being rendered without typographic presets.
|
|
*/
|
|
function block_core_navigation_typographic_presets_backcompatibility( $parsed_block ) {
|
|
if ( 'core/navigation' === $parsed_block['blockName'] ) {
|
|
$attribute_to_prefix_map = array(
|
|
'fontStyle' => 'var:preset|font-style|',
|
|
'fontWeight' => 'var:preset|font-weight|',
|
|
'textDecoration' => 'var:preset|text-decoration|',
|
|
'textTransform' => 'var:preset|text-transform|',
|
|
);
|
|
foreach ( $attribute_to_prefix_map as $style_attribute => $prefix ) {
|
|
if ( ! empty( $parsed_block['attrs']['style']['typography'][ $style_attribute ] ) ) {
|
|
$prefix_len = strlen( $prefix );
|
|
$attribute_value = &$parsed_block['attrs']['style']['typography'][ $style_attribute ];
|
|
if ( 0 === strncmp( $attribute_value, $prefix, $prefix_len ) ) {
|
|
$attribute_value = substr( $attribute_value, $prefix_len );
|
|
}
|
|
if ( 'textDecoration' === $style_attribute && 'strikethrough' === $attribute_value ) {
|
|
$attribute_value = 'line-through';
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $parsed_block;
|
|
}
|
|
|
|
add_filter( 'render_block_data', 'block_core_navigation_typographic_presets_backcompatibility' );
|