Changeset 52275 for trunk/src/wp-includes/blocks/navigation.php

Timestamp:

11/30/2021 12:22:30 AM (3 years ago)

Author:

noisysocks

Message:

Update @wordpress packages

Update packages to include these bug fixes from Gutenberg:

• Update Pattern block category and add documentation
• Fix non existent menu handling in nav block
• Make Reusable blocks available in the Site Editor
• Add caching to WP_Theme_JSON_Resolver_Gutenberg::get_user_data_from_custom_post_type()
• theme.json: add appearanceTools flag to opt-in into appearance UI controls
• Update the block theme folders to templates and parts
• Remove reference to gutenberg_, swap with wp_
• Use table layout in templates list screen
• Update featured image placeholder graphic.
• [Inserter]: Adjust order of theme blocks and reorder inserter items
• Implement suitable fallback for Nav block on front end of site when no menu selected
• Toggle Group Control: add tooltip
• Use first non-empty Nav post as primary fallback for Nav block
• Change .nvmrc and documentation for Node.js version (LTS to 14.18.1)
• Update: Migrate global styles user database data on the rest endpoint
• Update global styles public API
• Update: Rename user preset origin to custom
• Try always generating navigation post title
• Show all templates and template parts on the site editor list screens
• Highlight "Site" in the navigation panel
• Fix template part slug generation when creating through the block placeholder
• [Block Library - Post Title]: Fix render error when setting Page to homepage
• Add 'Clear customizations' button to template list page
• Gallery v1: Allow clicks within replace media placeholder state
• Site Editor: Set the <title> on the list page to be same as the CPT name
• Gallery: Fix stuck image size options loader
• Cover: Fix undo trap
• Add success and error snackbars to the templates list page
• Fix: theme colors cannot override defaults
• Fix: Color palette is not being stored
• Add elements support to the typography panel in global styles
• Make links plural in global styles
• Add: Gradient palette editor
• Update some small style regressions in the template list
• Add: Transparency support on global styles colors
• Fix: apply by slug on all origins
• Render empty Nav block if no fallback block can be utilised
• Allow filtering of Nav block fallback
• Fix Nav block fallback DB query to match on full block grammar start tag
• Remove unstable max pages attribute from Nav block
• DateTimePicker: set PM hours correctly
• Update delete template button
• Site Editor: Template list add rename action
• Fix Nav block editing wrong entity on creation of new Menu
• [REST] Restore the missing double slash in the ID received by /templates
• Add icons to navigation sidebar items
• Update function names for the public global styles API functions
• Templates Controller: Add missing 'is_custom' prop
• Rename gutenberg_ to wp_ for some functions that land in WordPress 5.9
• [Block Library - Template Part]:Remove support for conversion to Reusable block
• Global Styles: Call "palettes" and not "color palettes" on panel label
• Add button text when no colors found
• Update: Global Styes: Count all color palette origins on the palette counter
• Rename navigationMenuId to ref
• Offset the parent iframe when computing Popover position
• Fix: Failing PHPUnit test
• Show theme, plugin or author in Added By column with appropriate icon or avatar
• Add origin and author to template rest api

See #54487.
Props talldanwp, mamaduka, oandregal.

File:

• trunk/src/wp-includes/blocks/navigation.php (modified) (11 diffs)

trunk/src/wp-includes/blocks/navigation.php

@@ -10 +10 @@
  * which will be applied to the navigation markup in the front-end.
  *
- * @param  array $attributes Navigation block attributes.
+ * @param array $attributes Navigation block attributes.
+ *
  * @return array Colors CSS classes and inline styles.
  */
@@ -100 +101 @@
  * which will be applied to the navigation markup in the front-end.
  *
- * @param  array $attributes Navigation block attributes.
+ * @param array $attributes Navigation block attributes.
+ *
  * @return array Font size CSS classes and inline styles.
  */
@@ -133 +135 @@
 }
 
+
+/**
+ * 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.
@@ -143 +239 @@
  */
 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:
@@ -188 +289 @@
         $mapping = get_option( 'wp_navigation_areas', array() );
         if ( ! empty( $mapping[ $area ] ) ) {
-            $attributes['navigationMenuId'] = $mapping[ $area ];
-        }
-    }
-
+            $attributes['ref'] = $mapping[ $area ];
+        }
+    }
+
+    // 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( 'navigationMenuId', $attributes ) ) {
-        $navigation_post = get_post( $attributes['navigationMenuId'] );
+    if ( array_key_exists( 'ref', $attributes ) ) {
+        $navigation_post = get_post( $attributes['ref'] );
         if ( ! isset( $navigation_post ) ) {
             return '';
@@ -203 +308 @@
         // 'parse_blocks' includes a null block with '\n\n' as the content when
         // it encounters whitespace. This code strips it.
-        $compacted_blocks = array_filter(
-            $parsed_blocks,
-            function( $block ) {
-                return isset( $block['blockName'] );
-            }
-        );
+        $compacted_blocks = block_core_navigation_filter_out_empty_blocks( $parsed_blocks );
 
         // TODO - this uses the full navigation block attributes for the
@@ -215 +315 @@
     }
 
+    // If there are no inner blocks then fallback to rendering an appropriate fallback.
     if ( empty( $inner_blocks ) ) {
-        return '';
+        $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 );
+
     }
 
@@ -235 +346 @@
         $font_sizes['css_classes'],
         $is_responsive_menu ? array( 'is-responsive' ) : array(),
-        $layout_class ? array( $layout_class ) : array()
+        $layout_class ? array( $layout_class ) : array(),
+        $is_fallback ? array( 'is-fallback' ) : array()
     );
 
@@ -324 +436 @@
  * Register the navigation block.
  *
+ * @throws WP_Error An WP_Error exception parsing the block definition.
  * @uses render_block_core_navigation()
- * @throws WP_Error An WP_Error exception parsing the block definition.
  */
 function register_block_core_navigation() {
@@ -342 +454 @@
  *
  * @param array $parsed_block The block being rendered.
+ *
  * @return array The block being rendered without typographic presets.
  */
@@ -365 +478 @@
         }
     }
+
     return $parsed_block;
 }