Changeset 57049 for branches/6.4/src/wp-includes/blocks/query.php

Timestamp:

11/01/2023 06:09:01 PM (11 months ago)

Author:

hellofromTonya

Message:

Editor: 2nd update of npm packages for 6.4 RC3.

This second update for RC3 includes the following fixes:

• ​Update label for lightbox editor UI - string change.
• ​Query: Require queryId for enhanced pagination to prevent PHP notices and warnings.
• ​Query block enhanced pagination: Detect inner plugin blocks during render - which avoids turning off enhanced pagination in TT4, includes string changes.
• ​Query Loop block: Reuse existing screen-reader-text CSS class for the enhanced pagination aria-live region.

Follow up to [57034], [56987], [56961], [56849], [56818], [56816].

Reviewed by davidbaumwald , jorbin.
Merges [57048] to the 6.4 branch.

Props afercia, aristath, artemiosans, czapla, darerodz, glendaviesnz, hellofromTonya, jameskoster, joen, luisherranz, mikachan, ocean90, peterwilsoncc, ramonopoly, rajinsharwar, swissspidy.
Fixes #59411.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• src/wp-includes/blocks/query.php (modified) (5 diffs)

branches/6.4/src/wp-includes/blocks/query.php

@@ -11 +11 @@
  * @since 6.4.0
  *
- * @param array  $attributes Block attributes.
- * @param string $content    Block default content.
- * @param string $block      Block instance.
+ * @param array    $attributes Block attributes.
+ * @param string   $content    Block default content.
+ * @param WP_Block $block      The block instance.
  *
  * @return string Returns the modified output of the query block.
  */
 function render_block_core_query( $attributes, $content, $block ) {
-    if ( $attributes['enhancedPagination'] ) {
+    if ( $attributes['enhancedPagination'] && isset( $attributes['queryId'] ) ) {
         $p = new WP_HTML_Tag_Processor( $content );
         if ( $p->next_tag() ) {
@@ -49 +49 @@
                 $content,
                 '<div
-                    class="wp-block-query__enhanced-pagination-navigation-announce"
+                    class="wp-block-query__enhanced-pagination-navigation-announce screen-reader-text"
                     aria-live="polite"
                     data-wp-text="context.core.query.message"
@@ -68 +68 @@
         $script_handles = $block->block_type->view_script_handles;
         // If the script is not needed, and it is still in the `view_script_handles`, remove it.
-        if ( ! $attributes['enhancedPagination'] && in_array( $view_asset, $script_handles, true ) ) {
+        if (
+            ( ! $attributes['enhancedPagination'] || ! isset( $attributes['queryId'] ) )
+            && in_array( $view_asset, $script_handles, true )
+        ) {
             $block->block_type->view_script_handles = array_diff( $script_handles, array( $view_asset ) );
         }
         // If the script is needed, but it was previously removed, add it again.
-        if ( $attributes['enhancedPagination'] && ! in_array( $view_asset, $script_handles, true ) ) {
+        if ( $attributes['enhancedPagination'] && isset( $attributes['queryId'] ) && ! in_array( $view_asset, $script_handles, true ) ) {
             $block->block_type->view_script_handles = array_merge( $script_handles, array( $view_asset ) );
         }
@@ -81 +84 @@
         $style_handles = $block->block_type->style_handles;
         // If the styles are not needed, and they are still in the `style_handles`, remove them.
-        if ( ! $attributes['enhancedPagination'] && in_array( $style_asset, $style_handles, true ) ) {
+        if (
+            ( ! $attributes['enhancedPagination'] || ! isset( $attributes['queryId'] ) )
+            && in_array( $style_asset, $style_handles, true )
+        ) {
             $block->block_type->style_handles = array_diff( $style_handles, array( $style_asset ) );
         }
         // If the styles are needed, but they were previously removed, add them again.
-        if ( $attributes['enhancedPagination'] && ! in_array( $style_asset, $style_handles, true ) ) {
+        if ( $attributes['enhancedPagination'] && isset( $attributes['queryId'] ) && ! in_array( $style_asset, $style_handles, true ) ) {
             $block->block_type->style_handles = array_merge( $style_handles, array( $style_asset ) );
         }
@@ -124 +130 @@
 }
 add_action( 'init', 'register_block_core_query' );
+
+/**
+ * Traverse the tree of blocks looking for any plugin block (i.e., a block from
+ * an installed plugin) inside a Query block with the enhanced pagination
+ * enabled. If at least one is found, the enhanced pagination is effectively
+ * disabled to prevent any potential incompatibilities.
+ *
+ * @since 6.4.0
+ *
+ * @param array $parsed_block The block being rendered.
+ * @return string Returns the parsed block, unmodified.
+ */
+function block_core_query_disable_enhanced_pagination( $parsed_block ) {
+    static $enhanced_query_stack   = array();
+    static $dirty_enhanced_queries = array();
+    static $render_query_callback  = null;
+
+    $block_name = $parsed_block['blockName'];
+
+    if (
+        'core/query' === $block_name &&
+        isset( $parsed_block['attrs']['enhancedPagination'] ) &&
+        true === $parsed_block['attrs']['enhancedPagination'] &&
+        isset( $parsed_block['attrs']['queryId'] )
+    ) {
+        $enhanced_query_stack[] = $parsed_block['attrs']['queryId'];
+
+        if ( ! isset( $render_query_callback ) ) {
+            /**
+             * Filter that disables the enhanced pagination feature during block
+             * rendering when a plugin block has been found inside. It does so
+             * by adding an attribute called `data-wp-navigation-disabled` which
+             * is later handled by the front-end logic.
+             *
+             * @param string   $content  The block content.
+             * @param array    $block    The full block, including name and attributes.
+             * @return string Returns the modified output of the query block.
+             */
+            $render_query_callback = static function ( $content, $block ) use ( &$enhanced_query_stack, &$dirty_enhanced_queries, &$render_query_callback ) {
+                $has_enhanced_pagination =
+                    isset( $block['attrs']['enhancedPagination'] ) &&
+                    true === $block['attrs']['enhancedPagination'] &&
+                    isset( $block['attrs']['queryId'] );
+
+                if ( ! $has_enhanced_pagination ) {
+                    return $content;
+                }
+
+                if ( isset( $dirty_enhanced_queries[ $block['attrs']['queryId'] ] ) ) {
+                    $p = new WP_HTML_Tag_Processor( $content );
+                    if ( $p->next_tag() ) {
+                        $p->set_attribute( 'data-wp-navigation-disabled', 'true' );
+                    }
+                    $content = $p->get_updated_html();
+                    $dirty_enhanced_queries[ $block['attrs']['queryId'] ] = null;
+                }
+
+                array_pop( $enhanced_query_stack );
+
+                if ( empty( $enhanced_query_stack ) ) {
+                    remove_filter( 'render_block_core/query', $render_query_callback );
+                    $render_query_callback = null;
+                }
+
+                return $content;
+            };
+
+            add_filter( 'render_block_core/query', $render_query_callback, 10, 2 );
+        }
+    } elseif (
+        ! empty( $enhanced_query_stack ) &&
+        isset( $block_name ) &&
+        ( ! str_starts_with( $block_name, 'core/' ) || 'core/post-content' === $block_name )
+    ) {
+        foreach ( $enhanced_query_stack as $query_id ) {
+            $dirty_enhanced_queries[ $query_id ] = true;
+        }
+    }
+
+    return $parsed_block;
+}
+
+add_filter( 'render_block_data', 'block_core_query_disable_enhanced_pagination', 10, 1 );