Changeset 51382 for branches/5.8/src/wp-includes/blocks.php

Timestamp:

07/08/2021 05:27:27 PM (5 years ago)

Author:

jorbin

Message:

Posts: Prevent an empty excerpt when groups and nested column blocks are present.

This improves the logic within excerpt_remove_blocks() to better handle innerBlocks. This prevents an empty excerpt from being returned when core/columns, core/column, and core/group blocks are present.

This issue has been surfaced in the Query Loop block, where excerpts can be set to display.

This introduces the excerpt_allowed_wrapper_blocks filter for controlling which blocks should be considered wrapper blocks.

Wrapper blocks and their nested contents are not stripped by excerpt_remove_blocks(), allowing their contents to appear in generated excerpts.

Backports [51348], [51375], [51378], and [51379] to the 5.8 branch.

Fixes #53604.
Props aristath, jorbin, SergeyBiryukov, desrosj.
Unprops jorbin.

Location:

branches/5.8

Files:

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

branches/5.8/src/wp-includes/blocks.php

@@ -711 +711 @@
         );
 
-        $allowed_blocks = array_merge( $allowed_inner_blocks, array( 'core/columns' ) );
+        $allowed_wrapper_blocks = array(
+                'core/columns',
+                'core/column',
+                'core/group',
+        );
+
+        /**
+         * Filters the list of blocks that can be used as wrapper blocks, allowing
+         * excerpts to be generated from the `innerBlocks` of these wrappers.
+         *
+         * @since 5.8.0
+         *
+         * @param array $allowed_wrapper_blocks The list of allowed wrapper blocks.
+         */
+        $allowed_wrapper_blocks = apply_filters( 'excerpt_allowed_wrapper_blocks', $allowed_wrapper_blocks );
+
+        $allowed_blocks = array_merge( $allowed_inner_blocks, $allowed_wrapper_blocks );
 
         /**
@@ -730 +746 @@
                 if ( in_array( $block['blockName'], $allowed_blocks, true ) ) {
                         if ( ! empty( $block['innerBlocks'] ) ) {
-                                if ( 'core/columns' === $block['blockName'] ) {
-                                        $output .= _excerpt_render_inner_columns_blocks( $block, $allowed_inner_blocks );
+                                if ( in_array( $block['blockName'], $allowed_wrapper_blocks, true ) ) {
+                                        $output .= _excerpt_render_inner_blocks( $block, $allowed_blocks );
                                         continue;
                                 }
@@ -754 +770 @@
 
 /**
- * Render inner blocks from the `core/columns` block for generating an excerpt.
- *
- * @since 5.2.0
+ * Render inner blocks from the allowed wrapper blocks
+ * for generating an excerpt.
+ *
+ * @since 5.8
  * @access private
  *
- * @param array $columns        The parsed columns block.
+ * @param array $parsed_block   The parsed block.
  * @param array $allowed_blocks The list of allowed inner blocks.
  * @return string The rendered inner blocks.
  */
-function _excerpt_render_inner_columns_blocks( $columns, $allowed_blocks ) {
+function _excerpt_render_inner_blocks( $parsed_block, $allowed_blocks ) {
         $output = '';
 
-        foreach ( $columns['innerBlocks'] as $column ) {
-                foreach ( $column['innerBlocks'] as $inner_block ) {
-                        if ( in_array( $inner_block['blockName'], $allowed_blocks, true ) && empty( $inner_block['innerBlocks'] ) ) {
-                                $output .= render_block( $inner_block );
-                        }
+        foreach ( $parsed_block['innerBlocks'] as $inner_block ) {
+                if ( ! in_array( $inner_block['blockName'], $allowed_blocks, true ) ) {
+                        continue;
+                }
+
+                if ( empty( $inner_block['innerBlocks'] ) ) {
+                        $output .= render_block( $inner_block );
+                } else {
+                        $output .= _excerpt_render_inner_blocks( $inner_block, $allowed_blocks );
                 }
         }