--- a/wp/wp-includes/blocks/navigation.php Thu Sep 29 08:06:27 2022 +0200
+++ b/wp/wp-includes/blocks/navigation.php Fri Sep 05 18:40:08 2025 +0200
@@ -5,12 +5,730 @@
* @package WordPress
*/
+/**
+ * Helper functions used to render the navigation block.
+ *
+ * @since 6.5.0
+ */
+class WP_Navigation_Block_Renderer {
+
+ /**
+ * Used to determine whether or not a navigation has submenus.
+ *
+ * @since 6.5.0
+ */
+ private static $has_submenus = false;
+
+ /**
+ * Used to determine which blocks need an <li> wrapper.
+ *
+ * @since 6.5.0
+ *
+ * @var array
+ */
+ private static $needs_list_item_wrapper = array(
+ 'core/site-title',
+ 'core/site-logo',
+ 'core/social-links',
+ );
+
+ /**
+ * Keeps track of all the navigation names that have been seen.
+ *
+ * @since 6.5.0
+ *
+ * @var array
+ */
+ private static $seen_menu_names = array();
+
+ /**
+ * Returns whether or not this is responsive navigation.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return bool Returns whether or not this is responsive navigation.
+ */
+ private static function is_responsive( $attributes ) {
+ /**
+ * This is for backwards compatibility after the `isResponsive` attribute was been removed.
+ */
+
+ $has_old_responsive_attribute = ! empty( $attributes['isResponsive'] ) && $attributes['isResponsive'];
+ return isset( $attributes['overlayMenu'] ) && 'never' !== $attributes['overlayMenu'] || $has_old_responsive_attribute;
+ }
+
+ /**
+ * Returns whether or not a navigation has a submenu.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Block_List $inner_blocks The list of inner blocks.
+ * @return bool Returns whether or not a navigation has a submenu and also sets the member variable.
+ */
+ private static function has_submenus( $inner_blocks ) {
+ if ( true === static::$has_submenus ) {
+ return static::$has_submenus;
+ }
+
+ foreach ( $inner_blocks as $inner_block ) {
+ // If this is a page list then work out if any of the pages have children.
+ if ( 'core/page-list' === $inner_block->name ) {
+ $all_pages = get_pages(
+ array(
+ 'sort_column' => 'menu_order,post_title',
+ 'order' => 'asc',
+ )
+ );
+ foreach ( (array) $all_pages as $page ) {
+ if ( $page->post_parent ) {
+ static::$has_submenus = true;
+ break;
+ }
+ }
+ }
+ // If this is a navigation submenu then we know we have submenus.
+ if ( 'core/navigation-submenu' === $inner_block->name ) {
+ static::$has_submenus = true;
+ break;
+ }
+ }
+
+ return static::$has_submenus;
+ }
+
+ /**
+ * Determine whether the navigation blocks is interactive.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block_List $inner_blocks The list of inner blocks.
+ * @return bool Returns whether or not to load the view script.
+ */
+ private static function is_interactive( $attributes, $inner_blocks ) {
+ $has_submenus = static::has_submenus( $inner_blocks );
+ $is_responsive_menu = static::is_responsive( $attributes );
+ return ( $has_submenus && ( $attributes['openSubmenusOnClick'] || $attributes['showSubmenuIcon'] ) ) || $is_responsive_menu;
+ }
+
+ /**
+ * Returns whether or not a block needs a list item wrapper.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Block $block The block.
+ * @return bool Returns whether or not a block needs a list item wrapper.
+ */
+ private static function does_block_need_a_list_item_wrapper( $block ) {
+
+ /**
+ * Filter the list of blocks that need a list item wrapper.
+ *
+ * Affords the ability to customize which blocks need a list item wrapper when rendered
+ * within a core/navigation block.
+ * This is useful for blocks that are not list items but should be wrapped in a list
+ * item when used as a child of a navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $needs_list_item_wrapper The list of blocks that need a list item wrapper.
+ * @return array The list of blocks that need a list item wrapper.
+ */
+ $needs_list_item_wrapper = apply_filters( 'block_core_navigation_listable_blocks', static::$needs_list_item_wrapper );
+
+ return in_array( $block->name, $needs_list_item_wrapper, true );
+ }
+
+ /**
+ * Returns the markup for a single inner block.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Block $inner_block The inner block.
+ * @return string Returns the markup for a single inner block.
+ */
+ private static function get_markup_for_inner_block( $inner_block ) {
+ $inner_block_content = $inner_block->render();
+ if ( ! empty( $inner_block_content ) ) {
+ if ( static::does_block_need_a_list_item_wrapper( $inner_block ) ) {
+ return '<li class="wp-block-navigation-item">' . $inner_block_content . '</li>';
+ }
+ }
+
+ return $inner_block_content;
+ }
+
+ /**
+ * Returns the html for the inner blocks of the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block_List $inner_blocks The list of inner blocks.
+ * @return string Returns the html for the inner blocks of the navigation block.
+ */
+ private static function get_inner_blocks_html( $attributes, $inner_blocks ) {
+ $has_submenus = static::has_submenus( $inner_blocks );
+ $is_interactive = static::is_interactive( $attributes, $inner_blocks );
+
+ $style = static::get_styles( $attributes );
+ $class = static::get_classes( $attributes );
+ $container_attributes = get_block_wrapper_attributes(
+ array(
+ 'class' => 'wp-block-navigation__container ' . $class,
+ 'style' => $style,
+ )
+ );
+
+ $inner_blocks_html = '';
+ $is_list_open = false;
+
+ foreach ( $inner_blocks as $inner_block ) {
+ $inner_block_markup = static::get_markup_for_inner_block( $inner_block );
+ $p = new WP_HTML_Tag_Processor( $inner_block_markup );
+ $is_list_item = $p->next_tag( 'LI' );
+
+ if ( $is_list_item && ! $is_list_open ) {
+ $is_list_open = true;
+ $inner_blocks_html .= sprintf(
+ '<ul %1$s>',
+ $container_attributes
+ );
+ }
+
+ if ( ! $is_list_item && $is_list_open ) {
+ $is_list_open = false;
+ $inner_blocks_html .= '</ul>';
+ }
+
+ $inner_blocks_html .= $inner_block_markup;
+ }
+
+ if ( $is_list_open ) {
+ $inner_blocks_html .= '</ul>';
+ }
+
+ // Add directives to the submenu if needed.
+ if ( $has_submenus && $is_interactive ) {
+ $tags = new WP_HTML_Tag_Processor( $inner_blocks_html );
+ $inner_blocks_html = block_core_navigation_add_directives_to_submenu( $tags, $attributes );
+ }
+
+ return $inner_blocks_html;
+ }
+
+ /**
+ * Gets the inner blocks for the navigation block from the navigation post.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return WP_Block_List Returns the inner blocks for the navigation block.
+ */
+ private static function get_inner_blocks_from_navigation_post( $attributes ) {
+ $navigation_post = get_post( $attributes['ref'] );
+ if ( ! isset( $navigation_post ) ) {
+ return new WP_Block_List( array(), $attributes );
+ }
+
+ // Only published posts are valid. If this is changed then a corresponding change
+ // must also be implemented in `use-navigation-menu.js`.
+ if ( 'publish' === $navigation_post->post_status ) {
+ $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.
+ $blocks = block_core_navigation_filter_out_empty_blocks( $parsed_blocks );
+
+ if ( function_exists( 'set_ignored_hooked_blocks_metadata' ) ) {
+ // Run Block Hooks algorithm to inject hooked blocks.
+ $markup = block_core_navigation_insert_hooked_blocks( $blocks, $navigation_post );
+ $root_nav_block = parse_blocks( $markup )[0];
+
+ $blocks = isset( $root_nav_block['innerBlocks'] ) ? $root_nav_block['innerBlocks'] : $blocks;
+ }
+
+ // TODO - this uses the full navigation block attributes for the
+ // context which could be refined.
+ return new WP_Block_List( $blocks, $attributes );
+ }
+ }
+
+ /**
+ * Gets the inner blocks for the navigation block from the fallback.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return WP_Block_List Returns the inner blocks for the navigation block.
+ */
+ private static function get_inner_blocks_from_fallback( $attributes ) {
+ $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 new WP_Block_List( array(), $attributes );
+ }
+
+ return new WP_Block_List( $fallback_blocks, $attributes );
+ }
+
+ /**
+ * Gets the inner blocks for the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block $block The parsed block.
+ * @return WP_Block_List Returns the inner blocks for the navigation block.
+ */
+ private static function get_inner_blocks( $attributes, $block ) {
+ $inner_blocks = $block->inner_blocks;
+
+ // Ensure that blocks saved with the legacy ref attribute name (navigationMenuId) continue to render.
+ if ( array_key_exists( 'navigationMenuId', $attributes ) ) {
+ $attributes['ref'] = $attributes['navigationMenuId'];
+ }
+
+ // If:
+ // - the gutenberg plugin is active
+ // - `__unstableLocation` is defined
+ // - we have menu items at the defined location
+ // - we don't have a relationship to a `wp_navigation` Post (via `ref`).
+ // ...then create inner blocks from the classic menu assigned to that location.
+ if (
+ defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN &&
+ array_key_exists( '__unstableLocation', $attributes ) &&
+ ! array_key_exists( 'ref', $attributes ) &&
+ ! empty( block_core_navigation_get_menu_items_at_location( $attributes['__unstableLocation'] ) )
+ ) {
+ $inner_blocks = block_core_navigation_get_inner_blocks_from_unstable_location( $attributes );
+ }
+
+ // Load inner blocks from the navigation post.
+ if ( array_key_exists( 'ref', $attributes ) ) {
+ $inner_blocks = static::get_inner_blocks_from_navigation_post( $attributes );
+ }
+
+ // If there are no inner blocks then fallback to rendering an appropriate fallback.
+ if ( empty( $inner_blocks ) ) {
+ $inner_blocks = static::get_inner_blocks_from_fallback( $attributes );
+ }
+
+ /**
+ * Filter navigation block $inner_blocks.
+ * Allows modification of a navigation block menu items.
+ *
+ * @since 6.1.0
+ *
+ * @param \WP_Block_List $inner_blocks
+ */
+ $inner_blocks = apply_filters( 'block_core_navigation_render_inner_blocks', $inner_blocks );
+
+ $post_ids = block_core_navigation_get_post_ids( $inner_blocks );
+ if ( $post_ids ) {
+ _prime_post_caches( $post_ids, false, false );
+ }
+
+ return $inner_blocks;
+ }
+
+ /**
+ * Gets the name of the current navigation, if it has one.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return string Returns the name of the navigation.
+ */
+ private static function get_navigation_name( $attributes ) {
+
+ $navigation_name = $attributes['ariaLabel'] ?? '';
+
+ // Load the navigation post.
+ if ( array_key_exists( 'ref', $attributes ) ) {
+ $navigation_post = get_post( $attributes['ref'] );
+ if ( ! isset( $navigation_post ) ) {
+ return $navigation_name;
+ }
+
+ // Only published posts are valid. If this is changed then a corresponding change
+ // must also be implemented in `use-navigation-menu.js`.
+ if ( 'publish' === $navigation_post->post_status ) {
+ $navigation_name = $navigation_post->post_title;
+
+ // This is used to count the number of times a navigation name has been seen,
+ // so that we can ensure every navigation has a unique id.
+ if ( isset( static::$seen_menu_names[ $navigation_name ] ) ) {
+ ++static::$seen_menu_names[ $navigation_name ];
+ } else {
+ static::$seen_menu_names[ $navigation_name ] = 1;
+ }
+ }
+ }
+
+ return $navigation_name;
+ }
+
+ /**
+ * Returns the layout class for the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return string Returns the layout class for the navigation block.
+ */
+ private static function get_layout_class( $attributes ) {
+ $layout_justification = array(
+ 'left' => 'items-justified-left',
+ 'right' => 'items-justified-right',
+ 'center' => 'items-justified-center',
+ 'space-between' => 'items-justified-space-between',
+ );
+
+ $layout_class = '';
+ if (
+ isset( $attributes['layout']['justifyContent'] ) &&
+ isset( $layout_justification[ $attributes['layout']['justifyContent'] ] )
+ ) {
+ $layout_class .= $layout_justification[ $attributes['layout']['justifyContent'] ];
+ }
+ if ( isset( $attributes['layout']['orientation'] ) && 'vertical' === $attributes['layout']['orientation'] ) {
+ $layout_class .= ' is-vertical';
+ }
+
+ if ( isset( $attributes['layout']['flexWrap'] ) && 'nowrap' === $attributes['layout']['flexWrap'] ) {
+ $layout_class .= ' no-wrap';
+ }
+ return $layout_class;
+ }
+
+ /**
+ * Return classes for the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return string Returns the classes for the navigation block.
+ */
+ private static function get_classes( $attributes ) {
+ // Restore legacy classnames for submenu positioning.
+ $layout_class = static::get_layout_class( $attributes );
+ $colors = block_core_navigation_build_css_colors( $attributes );
+ $font_sizes = block_core_navigation_build_css_font_sizes( $attributes );
+ $is_responsive_menu = static::is_responsive( $attributes );
+
+ // Manually add block support text decoration as CSS class.
+ $text_decoration = $attributes['style']['typography']['textDecoration'] ?? null;
+ $text_decoration_class = sprintf( 'has-text-decoration-%s', $text_decoration );
+
+ $classes = array_merge(
+ $colors['css_classes'],
+ $font_sizes['css_classes'],
+ $is_responsive_menu ? array( 'is-responsive' ) : array(),
+ $layout_class ? array( $layout_class ) : array(),
+ $text_decoration ? array( $text_decoration_class ) : array()
+ );
+ return implode( ' ', $classes );
+ }
+
+ /**
+ * Get styles for the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return string Returns the styles for the navigation block.
+ */
+ private static function get_styles( $attributes ) {
+ $colors = block_core_navigation_build_css_colors( $attributes );
+ $font_sizes = block_core_navigation_build_css_font_sizes( $attributes );
+ $block_styles = isset( $attributes['styles'] ) ? $attributes['styles'] : '';
+ return $block_styles . $colors['inline_styles'] . $font_sizes['inline_styles'];
+ }
+
+ /**
+ * Get the responsive container markup
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block_List $inner_blocks The list of inner blocks.
+ * @param string $inner_blocks_html The markup for the inner blocks.
+ * @return string Returns the container markup.
+ */
+ private static function get_responsive_container_markup( $attributes, $inner_blocks, $inner_blocks_html ) {
+ $is_interactive = static::is_interactive( $attributes, $inner_blocks );
+ $colors = block_core_navigation_build_css_colors( $attributes );
+ $modal_unique_id = wp_unique_id( 'modal-' );
+
+ $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' : '',
+ );
+
+ $should_display_icon_label = isset( $attributes['hasIcon'] ) && true === $attributes['hasIcon'];
+ $toggle_button_icon = '<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" 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>';
+ if ( isset( $attributes['icon'] ) ) {
+ if ( 'menu' === $attributes['icon'] ) {
+ $toggle_button_icon = '<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M5 5v1.5h14V5H5zm0 7.8h14v-1.5H5v1.5zM5 19h14v-1.5H5V19z" /></svg>';
+ }
+ }
+ $toggle_button_content = $should_display_icon_label ? $toggle_button_icon : __( 'Menu' );
+ $toggle_close_button_icon = '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" 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>';
+ $toggle_close_button_content = $should_display_icon_label ? $toggle_close_button_icon : __( 'Close' );
+ $toggle_aria_label_open = $should_display_icon_label ? 'aria-label="' . __( 'Open menu' ) . '"' : ''; // Open button label.
+ $toggle_aria_label_close = $should_display_icon_label ? 'aria-label="' . __( 'Close menu' ) . '"' : ''; // Close button label.
+
+ // Add Interactivity API directives to the markup if needed.
+ $open_button_directives = '';
+ $responsive_container_directives = '';
+ $responsive_dialog_directives = '';
+ $close_button_directives = '';
+ if ( $is_interactive ) {
+ $open_button_directives = '
+ data-wp-on-async--click="actions.openMenuOnClick"
+ data-wp-on--keydown="actions.handleMenuKeydown"
+ ';
+ $responsive_container_directives = '
+ data-wp-class--has-modal-open="state.isMenuOpen"
+ data-wp-class--is-menu-open="state.isMenuOpen"
+ data-wp-watch="callbacks.initMenu"
+ data-wp-on--keydown="actions.handleMenuKeydown"
+ data-wp-on-async--focusout="actions.handleMenuFocusout"
+ tabindex="-1"
+ ';
+ $responsive_dialog_directives = '
+ data-wp-bind--aria-modal="state.ariaModal"
+ data-wp-bind--aria-label="state.ariaLabel"
+ data-wp-bind--role="state.roleAttribute"
+ ';
+ $close_button_directives = '
+ data-wp-on-async--click="actions.closeMenuOnClick"
+ ';
+ $responsive_container_content_directives = '
+ data-wp-watch="callbacks.focusFirstElement"
+ ';
+ }
+
+ $overlay_inline_styles = esc_attr( safecss_filter_attr( $colors['overlay_inline_styles'] ) );
+
+ return sprintf(
+ '<button aria-haspopup="dialog" %3$s class="%6$s" %10$s>%8$s</button>
+ <div class="%5$s" %7$s id="%1$s" %11$s>
+ <div class="wp-block-navigation__responsive-close" tabindex="-1">
+ <div class="wp-block-navigation__responsive-dialog" %12$s>
+ <button %4$s class="wp-block-navigation__responsive-container-close" %13$s>%9$s</button>
+ <div class="wp-block-navigation__responsive-container-content" %14$s id="%1$s-content">
+ %2$s
+ </div>
+ </div>
+ </div>
+ </div>',
+ esc_attr( $modal_unique_id ),
+ $inner_blocks_html,
+ $toggle_aria_label_open,
+ $toggle_aria_label_close,
+ esc_attr( implode( ' ', $responsive_container_classes ) ),
+ esc_attr( implode( ' ', $open_button_classes ) ),
+ ( ! empty( $overlay_inline_styles ) ) ? "style=\"$overlay_inline_styles\"" : '',
+ $toggle_button_content,
+ $toggle_close_button_content,
+ $open_button_directives,
+ $responsive_container_directives,
+ $responsive_dialog_directives,
+ $close_button_directives,
+ $responsive_container_content_directives
+ );
+ }
+
+ /**
+ * Get the wrapper attributes
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block_List $inner_blocks A list of inner blocks.
+ * @return string Returns the navigation block markup.
+ */
+ private static function get_nav_wrapper_attributes( $attributes, $inner_blocks ) {
+ $nav_menu_name = static::get_unique_navigation_name( $attributes );
+ $is_interactive = static::is_interactive( $attributes, $inner_blocks );
+ $is_responsive_menu = static::is_responsive( $attributes );
+ $style = static::get_styles( $attributes );
+ $class = static::get_classes( $attributes );
+ $wrapper_attributes = get_block_wrapper_attributes(
+ array(
+ 'class' => $class,
+ 'style' => $style,
+ 'aria-label' => $nav_menu_name,
+ )
+ );
+
+ if ( $is_responsive_menu ) {
+ $nav_element_directives = static::get_nav_element_directives( $is_interactive );
+ $wrapper_attributes .= ' ' . $nav_element_directives;
+ }
+
+ return $wrapper_attributes;
+ }
+
+ /**
+ * Gets the nav element directives.
+ *
+ * @since 6.5.0
+ *
+ * @param bool $is_interactive Whether the block is interactive.
+ * @return string the directives for the navigation element.
+ */
+ private static function get_nav_element_directives( $is_interactive ) {
+ if ( ! $is_interactive ) {
+ return '';
+ }
+ // When adding to this array be mindful of security concerns.
+ $nav_element_context = wp_interactivity_data_wp_context(
+ array(
+ 'overlayOpenedBy' => array(
+ 'click' => false,
+ 'hover' => false,
+ 'focus' => false,
+ ),
+ 'type' => 'overlay',
+ 'roleAttribute' => '',
+ 'ariaLabel' => __( 'Menu' ),
+ )
+ );
+ $nav_element_directives = '
+ data-wp-interactive="core/navigation" '
+ . $nav_element_context;
+
+ return $nav_element_directives;
+ }
+
+ /**
+ * Handle view script module loading.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block $block The parsed block.
+ * @param WP_Block_List $inner_blocks The list of inner blocks.
+ */
+ private static function handle_view_script_module_loading( $attributes, $block, $inner_blocks ) {
+ if ( static::is_interactive( $attributes, $inner_blocks ) ) {
+ $suffix = wp_scripts_get_suffix();
+ if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) {
+ $module_url = gutenberg_url( '/build/interactivity/navigation.min.js' );
+ }
+
+ wp_register_script_module(
+ '@wordpress/block-library/navigation',
+ isset( $module_url ) ? $module_url : includes_url( "blocks/navigation/view{$suffix}.js" ),
+ array( '@wordpress/interactivity' ),
+ defined( 'GUTENBERG_VERSION' ) ? GUTENBERG_VERSION : get_bloginfo( 'version' )
+ );
+ wp_enqueue_script_module( '@wordpress/block-library/navigation' );
+ }
+ }
+
+ /**
+ * Returns the markup for the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param WP_Block_List $inner_blocks The list of inner blocks.
+ * @return string Returns the navigation wrapper markup.
+ */
+ private static function get_wrapper_markup( $attributes, $inner_blocks ) {
+ $inner_blocks_html = static::get_inner_blocks_html( $attributes, $inner_blocks );
+ if ( static::is_responsive( $attributes ) ) {
+ return static::get_responsive_container_markup( $attributes, $inner_blocks, $inner_blocks_html );
+ }
+ return $inner_blocks_html;
+ }
+
+ /**
+ * Returns a unique name for the navigation.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @return string Returns a unique name for the navigation.
+ */
+ private static function get_unique_navigation_name( $attributes ) {
+ $nav_menu_name = static::get_navigation_name( $attributes );
+
+ // If the menu name has been used previously then append an ID
+ // to the name to ensure uniqueness across a given post.
+ if ( isset( static::$seen_menu_names[ $nav_menu_name ] ) && static::$seen_menu_names[ $nav_menu_name ] > 1 ) {
+ $count = static::$seen_menu_names[ $nav_menu_name ];
+ $nav_menu_name = $nav_menu_name . ' ' . ( $count );
+ }
+
+ return $nav_menu_name;
+ }
+
+ /**
+ * Renders the navigation block.
+ *
+ * @since 6.5.0
+ *
+ * @param array $attributes The block attributes.
+ * @param string $content The saved content.
+ * @param WP_Block $block The parsed block.
+ * @return string Returns the navigation block markup.
+ */
+ public static function render( $attributes, $content, $block ) {
+ /**
+ * 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'] );
+
+ $inner_blocks = static::get_inner_blocks( $attributes, $block );
+ // Prevent navigation blocks referencing themselves from rendering.
+ if ( block_core_navigation_block_contains_core_navigation( $inner_blocks ) ) {
+ return '';
+ }
+
+ static::handle_view_script_module_loading( $attributes, $block, $inner_blocks );
+
+ return sprintf(
+ '<nav %1$s>%2$s</nav>',
+ static::get_nav_wrapper_attributes( $attributes, $inner_blocks ),
+ static::get_wrapper_markup( $attributes, $inner_blocks )
+ );
+ }
+}
+
// These functions are used for the __unstableLocation feature and only active
// when the gutenberg plugin is active.
if ( defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN ) {
/**
* Returns the menu items for a WordPress menu location.
*
+ * @since 5.9.0
+ *
* @param string $location The menu location.
* @return array Menu items for the location.
*/
@@ -47,6 +765,8 @@
* Sorts a standard array of menu items into a nested structure keyed by the
* id of the parent menu.
*
+ * @since 5.9.0
+ *
* @param array $menu_items Menu items to sort.
* @return array An array keyed by the id of the parent menu where each element
* is an array of menu items that belong to that parent.
@@ -67,62 +787,94 @@
}
/**
- * Turns menu item data into a nested array of parsed blocks
+ * Gets the inner blocks for the navigation block from the unstable location attribute.
+ *
+ * @since 6.5.0
*
- * @param array $menu_items An array of menu items that represent
- * an individual level of a menu.
- * @param array $menu_items_by_parent_id An array keyed by the id of the
- * parent menu where each element is an
- * array of menu items that belong to
- * that parent.
- * @return array An array of parsed block data.
+ * @param array $attributes The block attributes.
+ * @return WP_Block_List Returns the inner blocks for the navigation block.
*/
- function block_core_navigation_parse_blocks_from_menu_items( $menu_items, $menu_items_by_parent_id ) {
+ function block_core_navigation_get_inner_blocks_from_unstable_location( $attributes ) {
+ $menu_items = block_core_navigation_get_menu_items_at_location( $attributes['__unstableLocation'] );
if ( empty( $menu_items ) ) {
- return array();
+ return new WP_Block_List( array(), $attributes );
}
- $blocks = array();
-
- foreach ( $menu_items as $menu_item ) {
- $class_name = ! empty( $menu_item->classes ) ? implode( ' ', (array) $menu_item->classes ) : null;
- $id = ( null !== $menu_item->object_id && 'custom' !== $menu_item->object ) ? $menu_item->object_id : null;
- $opens_in_new_tab = null !== $menu_item->target && '_blank' === $menu_item->target;
- $rel = ( null !== $menu_item->xfn && '' !== $menu_item->xfn ) ? $menu_item->xfn : null;
- $kind = null !== $menu_item->type ? str_replace( '_', '-', $menu_item->type ) : 'custom';
+ $menu_items_by_parent_id = block_core_navigation_sort_menu_items_by_parent_id( $menu_items );
+ $parsed_blocks = block_core_navigation_parse_blocks_from_menu_items( $menu_items_by_parent_id[0], $menu_items_by_parent_id );
+ return new WP_Block_List( $parsed_blocks, $attributes );
+ }
+}
- $block = array(
- 'blockName' => isset( $menu_items_by_parent_id[ $menu_item->ID ] ) ? 'core/navigation-submenu' : 'core/navigation-link',
- 'attrs' => array(
- 'className' => $class_name,
- 'description' => $menu_item->description,
- 'id' => $id,
- 'kind' => $kind,
- 'label' => $menu_item->title,
- 'opensInNewTab' => $opens_in_new_tab,
- 'rel' => $rel,
- 'title' => $menu_item->attr_title,
- 'type' => $menu_item->object,
- 'url' => $menu_item->url,
- ),
- );
+/**
+ * Add Interactivity API directives to the navigation-submenu and page-list
+ * blocks markup using the Tag Processor.
+ *
+ * @since 6.3.0
+ *
+ * @param WP_HTML_Tag_Processor $tags Markup of the navigation block.
+ * @param array $block_attributes Block attributes.
+ *
+ * @return string Submenu markup with the directives injected.
+ */
+function block_core_navigation_add_directives_to_submenu( $tags, $block_attributes ) {
+ while ( $tags->next_tag(
+ array(
+ 'tag_name' => 'LI',
+ 'class_name' => 'has-child',
+ )
+ ) ) {
+ // Add directives to the parent `<li>`.
+ $tags->set_attribute( 'data-wp-interactive', 'core/navigation' );
+ $tags->set_attribute( 'data-wp-context', '{ "submenuOpenedBy": { "click": false, "hover": false, "focus": false }, "type": "submenu" }' );
+ $tags->set_attribute( 'data-wp-watch', 'callbacks.initMenu' );
+ $tags->set_attribute( 'data-wp-on--focusout', 'actions.handleMenuFocusout' );
+ $tags->set_attribute( 'data-wp-on--keydown', 'actions.handleMenuKeydown' );
- $block['innerBlocks'] = isset( $menu_items_by_parent_id[ $menu_item->ID ] )
- ? block_core_navigation_parse_blocks_from_menu_items( $menu_items_by_parent_id[ $menu_item->ID ], $menu_items_by_parent_id )
- : array();
- $block['innerContent'] = array_map( 'serialize_block', $block['innerBlocks'] );
+ // This is a fix for Safari. Without it, Safari doesn't change the active
+ // element when the user clicks on a button. It can be removed once we add
+ // an overlay to capture the clicks, instead of relying on the focusout
+ // event.
+ $tags->set_attribute( 'tabindex', '-1' );
- $blocks[] = $block;
+ if ( ! isset( $block_attributes['openSubmenusOnClick'] ) || false === $block_attributes['openSubmenusOnClick'] ) {
+ $tags->set_attribute( 'data-wp-on-async--mouseenter', 'actions.openMenuOnHover' );
+ $tags->set_attribute( 'data-wp-on-async--mouseleave', 'actions.closeMenuOnHover' );
}
- return $blocks;
+ // Add directives to the toggle submenu button.
+ if ( $tags->next_tag(
+ array(
+ 'tag_name' => 'BUTTON',
+ 'class_name' => 'wp-block-navigation-submenu__toggle',
+ )
+ ) ) {
+ $tags->set_attribute( 'data-wp-on-async--click', 'actions.toggleMenuOnClick' );
+ $tags->set_attribute( 'data-wp-bind--aria-expanded', 'state.isMenuOpen' );
+ // The `aria-expanded` attribute for SSR is already added in the submenu block.
+ }
+ // Add directives to the submenu.
+ if ( $tags->next_tag(
+ array(
+ 'tag_name' => 'UL',
+ 'class_name' => 'wp-block-navigation__submenu-container',
+ )
+ ) ) {
+ $tags->set_attribute( 'data-wp-on-async--focus', 'actions.openMenuOnFocus' );
+ }
+
+ // Iterate through subitems if exist.
+ block_core_navigation_add_directives_to_submenu( $tags, $block_attributes );
}
+ return $tags->get_updated_html();
}
/**
* Build an array with CSS classes and inline styles defining the colors
* which will be applied to the navigation markup in the front-end.
*
+ * @since 5.9.0
+ *
* @param array $attributes Navigation block attributes.
*
* @return array Colors CSS classes and inline styles.
@@ -214,6 +966,8 @@
* 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.
*
+ * @since 5.9.0
+ *
* @param array $attributes Navigation block attributes.
*
* @return array Font size CSS classes and inline styles.
@@ -242,55 +996,29 @@
/**
* Returns the top-level submenu SVG chevron icon.
*
+ * @since 5.9.0
+ *
* @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" 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.
- $parsed_args = array(
- 'post_type' => 'wp_navigation',
- 'no_found_rows' => true,
- 'order' => 'ASC',
- 'orderby' => 'name',
- 'post_status' => 'publish',
- 'posts_per_page' => 20, // Try the first 20 posts.
- );
-
- $navigation_posts = new WP_Query( $parsed_args );
- foreach ( $navigation_posts->posts as $navigation_post ) {
- if ( has_blocks( $navigation_post ) ) {
- return $navigation_post;
- }
- }
-
- return 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.
*
+ * @since 5.9.0
+ *
* @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 ) {
+ static function ( $block ) {
return isset( $block['blockName'] );
}
);
@@ -300,21 +1028,43 @@
}
/**
+ * Returns true if the navigation block contains a nested navigation block.
+ *
+ * @since 6.2.0
+ *
+ * @param WP_Block_List $inner_blocks Inner block instance to be normalized.
+ * @return bool true if the navigation block contains a nested navigation block.
+ */
+function block_core_navigation_block_contains_core_navigation( $inner_blocks ) {
+ foreach ( $inner_blocks as $block ) {
+ if ( 'core/navigation' === $block->name ) {
+ return true;
+ }
+ if ( $block->inner_blocks && block_core_navigation_block_contains_core_navigation( $block->inner_blocks ) ) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
+/**
* 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.
*
+ * @since 5.9.0
+ *
* @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,
- ),
+ 'blockName' => 'core/page-list',
+ 'innerContent' => array(),
+ 'attrs' => array(),
),
);
@@ -322,18 +1072,27 @@
// 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 = WP_Navigation_Fallback::get_fallback();
- $navigation_post = block_core_navigation_get_first_non_empty_navigation();
-
- // Prefer using the first non-empty Navigation as fallback if available.
+ // Use 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 ) );
+ $parsed_blocks = parse_blocks( $navigation_post->post_content );
+ $maybe_fallback = block_core_navigation_filter_out_empty_blocks( $parsed_blocks );
// 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;
+
+ if ( function_exists( 'set_ignored_hooked_blocks_metadata' ) ) {
+ // Run Block Hooks algorithm to inject hooked blocks.
+ // We have to run it here because we need the post ID of the Navigation block to track ignored hooked blocks.
+ $markup = block_core_navigation_insert_hooked_blocks( $fallback_blocks, $navigation_post );
+ $blocks = parse_blocks( $markup );
+
+ if ( isset( $blocks[0]['innerBlocks'] ) ) {
+ $fallback_blocks = $blocks[0]['innerBlocks'];
+ }
+ }
}
/**
@@ -345,7 +1104,7 @@
*
* @since 5.9.0
*
- * @param array[] default fallback blocks provided by the default block mechanic.
+ * @param array[] $fallback_blocks default fallback blocks provided by the default block mechanic.
*/
return apply_filters( 'block_core_navigation_render_fallback', $fallback_blocks );
}
@@ -353,6 +1112,8 @@
/**
* Iterate through all inner blocks recursively and get navigation link block's post IDs.
*
+ * @since 6.0.0
+ *
* @param WP_Block_List $inner_blocks Block list class instance.
*
* @return array Array of post IDs.
@@ -365,6 +1126,8 @@
/**
* Get post IDs from a navigation link block instance.
*
+ * @since 6.0.0
+ *
* @param WP_Block $block Instance of a block.
*
* @return array Array of post IDs.
@@ -377,7 +1140,7 @@
}
if ( 'core/navigation-link' === $block->name || 'core/navigation-submenu' === $block->name ) {
- if ( $block->attributes && isset( $block->attributes['kind'] ) && 'post-type' === $block->attributes['kind'] ) {
+ if ( $block->attributes && isset( $block->attributes['kind'] ) && 'post-type' === $block->attributes['kind'] && isset( $block->attributes['id'] ) ) {
$post_ids[] = $block->attributes['id'];
}
}
@@ -388,259 +1151,23 @@
/**
* Renders the `core/navigation` block on server.
*
+ * @since 5.9.0
+ *
* @param array $attributes The block attributes.
* @param string $content The saved content.
* @param WP_Block $block The parsed block.
*
- * @return string Returns the post content with the legacy widget added.
+ * @return string Returns the navigation block markup.
*/
function render_block_core_navigation( $attributes, $content, $block ) {
-
- static $seen_menu_names = array();
-
- // 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;
-
- $nav_menu_name = '';
-
- /**
- * 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;
-
- // Ensure that blocks saved with the legacy ref attribute name (navigationMenuId) continue to render.
- if ( array_key_exists( 'navigationMenuId', $attributes ) ) {
- $attributes['ref'] = $attributes['navigationMenuId'];
- }
-
- // If:
- // - the gutenberg plugin is active
- // - `__unstableLocation` is defined
- // - we have menu items at the defined location
- // - we don't have a relationship to a `wp_navigation` Post (via `ref`).
- // ...then create inner blocks from the classic menu assigned to that location.
- if (
- defined( 'IS_GUTENBERG_PLUGIN' ) && IS_GUTENBERG_PLUGIN &&
- array_key_exists( '__unstableLocation', $attributes ) &&
- ! array_key_exists( 'ref', $attributes ) &&
- ! empty( block_core_navigation_get_menu_items_at_location( $attributes['__unstableLocation'] ) )
- ) {
- $menu_items = block_core_navigation_get_menu_items_at_location( $attributes['__unstableLocation'] );
- if ( empty( $menu_items ) ) {
- return '';
- }
-
- $menu_items_by_parent_id = block_core_navigation_sort_menu_items_by_parent_id( $menu_items );
- $parsed_blocks = block_core_navigation_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 );
- }
-
- // Load inner blocks from the navigation post.
- if ( array_key_exists( 'ref', $attributes ) ) {
- $navigation_post = get_post( $attributes['ref'] );
- if ( ! isset( $navigation_post ) ) {
- return '';
- }
-
- $nav_menu_name = $navigation_post->post_title;
-
- if ( isset( $seen_menu_names[ $nav_menu_name ] ) ) {
- ++$seen_menu_names[ $nav_menu_name ];
- } else {
- $seen_menu_names[ $nav_menu_name ] = 1;
- }
-
- $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 );
-
- }
-
- $layout_justification = array(
- 'left' => 'items-justified-left',
- 'right' => 'items-justified-right',
- 'center' => 'items-justified-center',
- 'space-between' => 'items-justified-space-between',
- );
-
- // Restore legacy classnames for submenu positioning.
- $layout_class = '';
- if ( isset( $attributes['layout']['justifyContent'] ) ) {
- $layout_class .= $layout_justification[ $attributes['layout']['justifyContent'] ];
- }
- if ( isset( $attributes['layout']['orientation'] ) && 'vertical' === $attributes['layout']['orientation'] ) {
- $layout_class .= ' is-vertical';
- }
-
- if ( isset( $attributes['layout']['flexWrap'] ) && 'nowrap' === $attributes['layout']['flexWrap'] ) {
- $layout_class .= ' no-wrap';
- }
-
- // Manually add block support text decoration as CSS class.
- $text_decoration = _wp_array_get( $attributes, array( 'style', 'typography', 'textDecoration' ), null );
- $text_decoration_class = sprintf( 'has-text-decoration-%s', $text_decoration );
-
- $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(),
- $text_decoration ? array( $text_decoration_class ) : array()
- );
-
- $post_ids = block_core_navigation_get_post_ids( $inner_blocks );
- if ( $post_ids ) {
- _prime_post_caches( $post_ids, false, false );
- }
-
- $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'] : '';
-
- // If the menu name has been used previously then append an ID
- // to the name to ensure uniqueness across a given post.
- if ( isset( $seen_menu_names[ $nav_menu_name ] ) && $seen_menu_names[ $nav_menu_name ] > 1 ) {
- $count = $seen_menu_names[ $nav_menu_name ];
- $nav_menu_name = $nav_menu_name . ' ' . ( $count );
- }
-
- $wrapper_attributes = get_block_wrapper_attributes(
- array(
- 'class' => implode( ' ', $classes ),
- 'style' => $block_styles . $colors['inline_styles'] . $font_sizes['inline_styles'],
- 'aria-label' => $nav_menu_name,
- )
- );
-
- $modal_unique_id = wp_unique_id( 'modal-' );
-
- // 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' : '',
- );
-
- $toggle_button_icon = '<svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" 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>';
- $should_display_icon_label = isset( $attributes['hasIcon'] ) && true === $attributes['hasIcon'];
- $toggle_button_content = $should_display_icon_label ? $toggle_button_icon : 'Menu';
-
- $responsive_container_markup = sprintf(
- '<button aria-haspopup="true" aria-label="%3$s" class="%6$s" data-micromodal-trigger="%1$s">%9$s</button>
- <div class="%5$s" style="%7$s" id="%1$s">
- <div class="wp-block-navigation__responsive-close" tabindex="-1" data-micromodal-close>
- <div class="wp-block-navigation__responsive-dialog" aria-label="%8$s">
- <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" 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="%1$s-content">
- %2$s
- </div>
- </div>
- </div>
- </div>',
- esc_attr( $modal_unique_id ),
- $inner_blocks_html,
- __( 'Open menu' ), // Open button label.
- __( 'Close menu' ), // Close button label.
- esc_attr( implode( ' ', $responsive_container_classes ) ),
- esc_attr( implode( ' ', $open_button_classes ) ),
- safecss_filter_attr( $colors['overlay_inline_styles'] ),
- __( 'Menu' ),
- $toggle_button_content
- );
-
- return sprintf(
- '<nav %1$s>%2$s</nav>',
- $wrapper_attributes,
- $responsive_container_markup
- );
+ return WP_Navigation_Block_Renderer::render( $attributes, $content, $block );
}
/**
* Register the navigation block.
*
+ * @since 5.9.0
+ *
* @uses render_block_core_navigation()
* @throws WP_Error An WP_Error exception parsing the block definition.
*/
@@ -658,6 +1185,8 @@
/**
* Filter that changes the parsed attribute values of navigation blocks contain typographic presets to contain the values directly.
*
+ * @since 5.9.0
+ *
* @param array $parsed_block The block being rendered.
*
* @return array The block being rendered without typographic presets.
@@ -688,3 +1217,474 @@
}
add_filter( 'render_block_data', 'block_core_navigation_typographic_presets_backcompatibility' );
+
+/**
+ * Turns menu item data into a nested array of parsed blocks
+ *
+ * @since 5.9.0
+ *
+ * @deprecated 6.3.0 Use WP_Navigation_Fallback::parse_blocks_from_menu_items() instead.
+ *
+ * @param array $menu_items An array of menu items that represent
+ * an individual level of a menu.
+ * @param array $menu_items_by_parent_id An array keyed by the id of the
+ * parent menu where each element is an
+ * array of menu items that belong to
+ * that parent.
+ * @return array An array of parsed block data.
+ */
+function block_core_navigation_parse_blocks_from_menu_items( $menu_items, $menu_items_by_parent_id ) {
+
+ _deprecated_function( __FUNCTION__, '6.3.0', 'WP_Navigation_Fallback::parse_blocks_from_menu_items' );
+
+ if ( empty( $menu_items ) ) {
+ return array();
+ }
+
+ $blocks = array();
+
+ foreach ( $menu_items as $menu_item ) {
+ $class_name = ! empty( $menu_item->classes ) ? implode( ' ', (array) $menu_item->classes ) : null;
+ $id = ( null !== $menu_item->object_id && 'custom' !== $menu_item->object ) ? $menu_item->object_id : null;
+ $opens_in_new_tab = null !== $menu_item->target && '_blank' === $menu_item->target;
+ $rel = ( null !== $menu_item->xfn && '' !== $menu_item->xfn ) ? $menu_item->xfn : null;
+ $kind = null !== $menu_item->type ? str_replace( '_', '-', $menu_item->type ) : 'custom';
+
+ $block = array(
+ 'blockName' => isset( $menu_items_by_parent_id[ $menu_item->ID ] ) ? 'core/navigation-submenu' : 'core/navigation-link',
+ 'attrs' => array(
+ 'className' => $class_name,
+ 'description' => $menu_item->description,
+ 'id' => $id,
+ 'kind' => $kind,
+ 'label' => $menu_item->title,
+ 'opensInNewTab' => $opens_in_new_tab,
+ 'rel' => $rel,
+ 'title' => $menu_item->attr_title,
+ 'type' => $menu_item->object,
+ 'url' => $menu_item->url,
+ ),
+ );
+
+ $block['innerBlocks'] = isset( $menu_items_by_parent_id[ $menu_item->ID ] )
+ ? block_core_navigation_parse_blocks_from_menu_items( $menu_items_by_parent_id[ $menu_item->ID ], $menu_items_by_parent_id )
+ : array();
+ $block['innerContent'] = array_map( 'serialize_block', $block['innerBlocks'] );
+
+ $blocks[] = $block;
+ }
+
+ return $blocks;
+}
+
+/**
+ * Get the classic navigation menu to use as a fallback.
+ *
+ * @since 6.2.0
+ *
+ * @deprecated 6.3.0 Use WP_Navigation_Fallback::get_classic_menu_fallback() instead.
+ *
+ * @return object WP_Term The classic navigation.
+ */
+function block_core_navigation_get_classic_menu_fallback() {
+
+ _deprecated_function( __FUNCTION__, '6.3.0', 'WP_Navigation_Fallback::get_classic_menu_fallback' );
+
+ $classic_nav_menus = wp_get_nav_menus();
+
+ // If menus exist.
+ if ( $classic_nav_menus && ! is_wp_error( $classic_nav_menus ) ) {
+ // Handles simple use case where user has a classic menu and switches to a block theme.
+
+ // Returns the menu assigned to location `primary`.
+ $locations = get_nav_menu_locations();
+ if ( isset( $locations['primary'] ) ) {
+ $primary_menu = wp_get_nav_menu_object( $locations['primary'] );
+ if ( $primary_menu ) {
+ return $primary_menu;
+ }
+ }
+
+ // Returns a menu if `primary` is its slug.
+ foreach ( $classic_nav_menus as $classic_nav_menu ) {
+ if ( 'primary' === $classic_nav_menu->slug ) {
+ return $classic_nav_menu;
+ }
+ }
+
+ // Otherwise return the most recently created classic menu.
+ usort(
+ $classic_nav_menus,
+ static function ( $a, $b ) {
+ return $b->term_id - $a->term_id;
+ }
+ );
+ return $classic_nav_menus[0];
+ }
+}
+
+/**
+ * Converts a classic navigation to blocks.
+ *
+ * @since 6.2.0
+ *
+ * @deprecated 6.3.0 Use WP_Navigation_Fallback::get_classic_menu_fallback_blocks() instead.
+ *
+ * @param object $classic_nav_menu WP_Term The classic navigation object to convert.
+ * @return array the normalized parsed blocks.
+ */
+function block_core_navigation_get_classic_menu_fallback_blocks( $classic_nav_menu ) {
+
+ _deprecated_function( __FUNCTION__, '6.3.0', 'WP_Navigation_Fallback::get_classic_menu_fallback_blocks' );
+
+ // BEGIN: Code that already exists in wp_nav_menu().
+ $menu_items = wp_get_nav_menu_items( $classic_nav_menu->term_id, array( 'update_post_term_cache' => false ) );
+
+ // Set up the $menu_item variables.
+ _wp_menu_item_classes_by_context( $menu_items );
+
+ $sorted_menu_items = array();
+ foreach ( (array) $menu_items as $menu_item ) {
+ $sorted_menu_items[ $menu_item->menu_order ] = $menu_item;
+ }
+
+ unset( $menu_items, $menu_item );
+
+ // END: Code that already exists in wp_nav_menu().
+
+ $menu_items_by_parent_id = array();
+ foreach ( $sorted_menu_items as $menu_item ) {
+ $menu_items_by_parent_id[ $menu_item->menu_item_parent ][] = $menu_item;
+ }
+
+ $inner_blocks = block_core_navigation_parse_blocks_from_menu_items(
+ isset( $menu_items_by_parent_id[0] )
+ ? $menu_items_by_parent_id[0]
+ : array(),
+ $menu_items_by_parent_id
+ );
+
+ return serialize_blocks( $inner_blocks );
+}
+
+/**
+ * If there's a classic menu then use it as a fallback.
+ *
+ * @since 6.2.0
+ *
+ * @deprecated 6.3.0 Use WP_Navigation_Fallback::create_classic_menu_fallback() instead.
+ *
+ * @return array the normalized parsed blocks.
+ */
+function block_core_navigation_maybe_use_classic_menu_fallback() {
+
+ _deprecated_function( __FUNCTION__, '6.3.0', 'WP_Navigation_Fallback::create_classic_menu_fallback' );
+
+ // See if we have a classic menu.
+ $classic_nav_menu = block_core_navigation_get_classic_menu_fallback();
+
+ if ( ! $classic_nav_menu ) {
+ return;
+ }
+
+ // If we have a classic menu then convert it to blocks.
+ $classic_nav_menu_blocks = block_core_navigation_get_classic_menu_fallback_blocks( $classic_nav_menu );
+
+ if ( empty( $classic_nav_menu_blocks ) ) {
+ return;
+ }
+
+ // Create a new navigation menu from the classic menu.
+ $wp_insert_post_result = wp_insert_post(
+ array(
+ 'post_content' => $classic_nav_menu_blocks,
+ 'post_title' => $classic_nav_menu->name,
+ 'post_name' => $classic_nav_menu->slug,
+ 'post_status' => 'publish',
+ 'post_type' => 'wp_navigation',
+ ),
+ true // So that we can check whether the result is an error.
+ );
+
+ if ( is_wp_error( $wp_insert_post_result ) ) {
+ return;
+ }
+
+ // Fetch the most recently published navigation which will be the classic one created above.
+ return block_core_navigation_get_most_recently_published_navigation();
+}
+
+/**
+ * Finds the most recently published `wp_navigation` Post.
+ *
+ * @since 6.1.0
+ *
+ * @deprecated 6.3.0 Use WP_Navigation_Fallback::get_most_recently_published_navigation() instead.
+ *
+ * @return WP_Post|null the first non-empty Navigation or null.
+ */
+function block_core_navigation_get_most_recently_published_navigation() {
+
+ _deprecated_function( __FUNCTION__, '6.3.0', 'WP_Navigation_Fallback::get_most_recently_published_navigation' );
+
+ // Default to the most recently created menu.
+ $parsed_args = array(
+ 'post_type' => 'wp_navigation',
+ 'no_found_rows' => true,
+ 'update_post_meta_cache' => false,
+ 'update_post_term_cache' => false,
+ 'order' => 'DESC',
+ 'orderby' => 'date',
+ 'post_status' => 'publish',
+ 'posts_per_page' => 1, // get only the most recent.
+ );
+
+ $navigation_post = new WP_Query( $parsed_args );
+ if ( count( $navigation_post->posts ) > 0 ) {
+ return $navigation_post->posts[0];
+ }
+
+ return null;
+}
+
+/**
+ * Accepts the serialized markup of a block and its inner blocks, and returns serialized markup of the inner blocks.
+ *
+ * @since 6.5.0
+ *
+ * @param string $serialized_block The serialized markup of a block and its inner blocks.
+ * @return string
+ */
+function block_core_navigation_remove_serialized_parent_block( $serialized_block ) {
+ $start = strpos( $serialized_block, '-->' ) + strlen( '-->' );
+ $end = strrpos( $serialized_block, '<!--' );
+ return substr( $serialized_block, $start, $end - $start );
+}
+
+/**
+ * Mock a parsed block for the Navigation block given its inner blocks and the `wp_navigation` post object.
+ * The `wp_navigation` post's `_wp_ignored_hooked_blocks` meta is queried to add the `metadata.ignoredHookedBlocks` attribute.
+ *
+ * @since 6.5.0
+ *
+ * @param array $inner_blocks Parsed inner blocks of a Navigation block.
+ * @param WP_Post $post `wp_navigation` post object corresponding to the block.
+ *
+ * @return array the normalized parsed blocks.
+ */
+function block_core_navigation_mock_parsed_block( $inner_blocks, $post ) {
+ $attributes = array();
+
+ if ( isset( $post->ID ) ) {
+ $ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true );
+ if ( ! empty( $ignored_hooked_blocks ) ) {
+ $ignored_hooked_blocks = json_decode( $ignored_hooked_blocks, true );
+ $attributes['metadata'] = array(
+ 'ignoredHookedBlocks' => $ignored_hooked_blocks,
+ );
+ }
+ }
+
+ $mock_anchor_parent_block = array(
+ 'blockName' => 'core/navigation',
+ 'attrs' => $attributes,
+ 'innerBlocks' => $inner_blocks,
+ 'innerContent' => array_fill( 0, count( $inner_blocks ), null ),
+ );
+
+ return $mock_anchor_parent_block;
+}
+
+/**
+ * Insert hooked blocks into a Navigation block.
+ *
+ * Given a Navigation block's inner blocks and its corresponding `wp_navigation` post object,
+ * this function inserts hooked blocks into it, and returns the serialized inner blocks in a
+ * mock Navigation block wrapper.
+ *
+ * If there are any hooked blocks that need to be inserted as the Navigation block's first or last
+ * children, the `wp_navigation` post's `_wp_ignored_hooked_blocks` meta is checked to see if any
+ * of those hooked blocks should be exempted from insertion.
+ *
+ * @since 6.5.0
+ *
+ * @param array $inner_blocks Parsed inner blocks of a Navigation block.
+ * @param WP_Post $post `wp_navigation` post object corresponding to the block.
+ * @return string Serialized inner blocks in mock Navigation block wrapper, with hooked blocks inserted, if any.
+ */
+function block_core_navigation_insert_hooked_blocks( $inner_blocks, $post ) {
+ $mock_navigation_block = block_core_navigation_mock_parsed_block( $inner_blocks, $post );
+ $hooked_blocks = get_hooked_blocks();
+ $before_block_visitor = null;
+ $after_block_visitor = null;
+
+ if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
+ $before_block_visitor = make_before_block_visitor( $hooked_blocks, $post, 'insert_hooked_blocks' );
+ $after_block_visitor = make_after_block_visitor( $hooked_blocks, $post, 'insert_hooked_blocks' );
+ }
+
+ return traverse_and_serialize_block( $mock_navigation_block, $before_block_visitor, $after_block_visitor );
+}
+
+/**
+ * Insert ignoredHookedBlocks meta into the Navigation block and its inner blocks.
+ *
+ * Given a Navigation block's inner blocks and its corresponding `wp_navigation` post object,
+ * this function inserts ignoredHookedBlocks meta into it, and returns the serialized inner blocks in a
+ * mock Navigation block wrapper.
+ *
+ * @since 6.5.0
+ *
+ * @param array $inner_blocks Parsed inner blocks of a Navigation block.
+ * @param WP_Post $post `wp_navigation` post object corresponding to the block.
+ * @return string Serialized inner blocks in mock Navigation block wrapper, with hooked blocks inserted, if any.
+ */
+function block_core_navigation_set_ignored_hooked_blocks_metadata( $inner_blocks, $post ) {
+ $mock_navigation_block = block_core_navigation_mock_parsed_block( $inner_blocks, $post );
+ $hooked_blocks = get_hooked_blocks();
+ $before_block_visitor = null;
+ $after_block_visitor = null;
+
+ if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
+ $before_block_visitor = make_before_block_visitor( $hooked_blocks, $post, 'set_ignored_hooked_blocks_metadata' );
+ $after_block_visitor = make_after_block_visitor( $hooked_blocks, $post, 'set_ignored_hooked_blocks_metadata' );
+ }
+
+ return traverse_and_serialize_block( $mock_navigation_block, $before_block_visitor, $after_block_visitor );
+}
+
+/**
+ * Updates the post meta with the list of ignored hooked blocks when the navigation is created or updated via the REST API.
+ *
+ * @access private
+ * @since 6.5.0
+ *
+ * @param stdClass $post Post object.
+ * @return stdClass The updated post object.
+ */
+function block_core_navigation_update_ignore_hooked_blocks_meta( $post ) {
+ /*
+ * In this scenario the user has likely tried to create a navigation via the REST API.
+ * In which case we won't have a post ID to work with and store meta against.
+ */
+ if ( empty( $post->ID ) ) {
+ return $post;
+ }
+
+ /**
+ * Skip meta generation when consumers intentionally update specific Navigation fields
+ * and omit the content update.
+ */
+ if ( ! isset( $post->post_content ) ) {
+ return $post;
+ }
+
+ /*
+ * We run the Block Hooks mechanism to inject the `metadata.ignoredHookedBlocks` attribute into
+ * all anchor blocks. For the root level, we create a mock Navigation and extract them from there.
+ */
+ $blocks = parse_blocks( $post->post_content );
+
+ /*
+ * Block Hooks logic requires a `WP_Post` object (rather than the `stdClass` with the updates that
+ * we're getting from the `rest_pre_insert_wp_navigation` filter) as its second argument (to be
+ * used as context for hooked blocks insertion).
+ * We thus have to look it up from the DB,based on `$post->ID`.
+ */
+ $markup = block_core_navigation_set_ignored_hooked_blocks_metadata( $blocks, get_post( $post->ID ) );
+
+ $root_nav_block = parse_blocks( $markup )[0];
+ $ignored_hooked_blocks = isset( $root_nav_block['attrs']['metadata']['ignoredHookedBlocks'] )
+ ? $root_nav_block['attrs']['metadata']['ignoredHookedBlocks']
+ : array();
+
+ if ( ! empty( $ignored_hooked_blocks ) ) {
+ $existing_ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true );
+ if ( ! empty( $existing_ignored_hooked_blocks ) ) {
+ $existing_ignored_hooked_blocks = json_decode( $existing_ignored_hooked_blocks, true );
+ $ignored_hooked_blocks = array_unique( array_merge( $ignored_hooked_blocks, $existing_ignored_hooked_blocks ) );
+ }
+ update_post_meta( $post->ID, '_wp_ignored_hooked_blocks', json_encode( $ignored_hooked_blocks ) );
+ }
+
+ $post->post_content = block_core_navigation_remove_serialized_parent_block( $markup );
+ return $post;
+}
+
+/*
+ * Before adding our filter, we verify if it's already added in Core.
+ * However, during the build process, Gutenberg automatically prefixes our functions with "gutenberg_".
+ * Therefore, we concatenate the Core's function name to circumvent this prefix for our check.
+ */
+$rest_insert_wp_navigation_core_callback = 'block_core_navigation_' . 'update_ignore_hooked_blocks_meta'; // phpcs:ignore Generic.Strings.UnnecessaryStringConcat.Found
+
+/*
+ * Do not add the `block_core_navigation_update_ignore_hooked_blocks_meta` filter in the following cases:
+ * - If Core has added the `update_ignored_hooked_blocks_postmeta` filter already (WP >= 6.6);
+ * - or if the `set_ignored_hooked_blocks_metadata` function is unavailable (which is required for the filter to work. It was introduced by WP 6.5 but is not present in Gutenberg's WP 6.5 compatibility layer);
+ * - or if the `$rest_insert_wp_navigation_core_callback` filter has already been added.
+ */
+if (
+ ! has_filter( 'rest_pre_insert_wp_navigation', 'update_ignored_hooked_blocks_postmeta' ) &&
+ function_exists( 'set_ignored_hooked_blocks_metadata' ) &&
+ ! has_filter( 'rest_pre_insert_wp_navigation', $rest_insert_wp_navigation_core_callback )
+) {
+ add_filter( 'rest_pre_insert_wp_navigation', 'block_core_navigation_update_ignore_hooked_blocks_meta' );
+}
+
+/*
+ * Previous versions of Gutenberg were attaching the block_core_navigation_update_ignore_hooked_blocks_meta
+ * function to the `rest_insert_wp_navigation` _action_ (rather than the `rest_pre_insert_wp_navigation` _filter_).
+ * To avoid collisions, we need to remove the filter from that action if it's present.
+ */
+if ( has_filter( 'rest_insert_wp_navigation', $rest_insert_wp_navigation_core_callback ) ) {
+ remove_filter( 'rest_insert_wp_navigation', $rest_insert_wp_navigation_core_callback );
+}
+
+/**
+ * Hooks into the REST API response for the core/navigation block and adds the first and last inner blocks.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_REST_Response $response The response object.
+ * @param WP_Post $post Post object.
+ * @return WP_REST_Response The response object.
+ */
+function block_core_navigation_insert_hooked_blocks_into_rest_response( $response, $post ) {
+ if ( ! isset( $response->data['content']['raw'] ) || ! isset( $response->data['content']['rendered'] ) ) {
+ return $response;
+ }
+ $parsed_blocks = parse_blocks( $response->data['content']['raw'] );
+ $content = block_core_navigation_insert_hooked_blocks( $parsed_blocks, $post );
+
+ // Remove mock Navigation block wrapper.
+ $content = block_core_navigation_remove_serialized_parent_block( $content );
+
+ $response->data['content']['raw'] = $content;
+
+ /** This filter is documented in wp-includes/post-template.php */
+ $response->data['content']['rendered'] = apply_filters( 'the_content', $content );
+
+ return $response;
+}
+
+/*
+ * Before adding our filter, we verify if it's already added in Core.
+ * However, during the build process, Gutenberg automatically prefixes our functions with "gutenberg_".
+ * Therefore, we concatenate the Core's function name to circumvent this prefix for our check.
+ */
+$rest_prepare_wp_navigation_core_callback = 'block_core_navigation_' . 'insert_hooked_blocks_into_rest_response';
+
+/*
+ * Do not add the `block_core_navigation_insert_hooked_blocks_into_rest_response` filter in the following cases:
+ * - If Core has added the `insert_hooked_blocks_into_rest_response` filter already (WP >= 6.6);
+ * - or if the `set_ignored_hooked_blocks_metadata` function is unavailable (which is required for the filter to work. It was introduced by WP 6.5 but is not present in Gutenberg's WP 6.5 compatibility layer);
+ * - or if the `$rest_prepare_wp_navigation_core_callback` filter has already been added.
+ */
+if (
+ ! has_filter( 'rest_prepare_wp_navigation', 'insert_hooked_blocks_into_rest_response' ) &&
+ function_exists( 'set_ignored_hooked_blocks_metadata' ) &&
+ ! has_filter( 'rest_prepare_wp_navigation', $rest_prepare_wp_navigation_core_callback )
+) {
+ add_filter( 'rest_prepare_wp_navigation', 'block_core_navigation_insert_hooked_blocks_into_rest_response', 10, 3 );
+}