Changeset 51382

Timestamp:

07/08/2021 05:27:27 PM (3 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)
• src/wp-includes/deprecated.php (modified) (1 diff)
• tests/phpunit/tests/post/getTheExcerpt.php (modified) (1 diff)

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 );
         }
     }

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

@@ -4208 +4208 @@
     wp_strict_cross_origin_referrer();
 }
+
+/**
+ * Render inner blocks from the `core/columns` block for generating an excerpt.
+ *
+ * @since 5.2.0
+ * @deprecated 5.8.0
+ *
+ * @access private
+ *
+ * @param array $columns        The parsed columns 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 ) {
+    _deprecated_function( __FUNCTION__, '5.8.0', '_excerpt_render_inner_blocks()' );
+    return _excerpt_render_inner_blocks( $columns, $allowed_blocks );
+}

branches/5.8/tests/phpunit/tests/post/getTheExcerpt.php

@@ -146 +146 @@
         $this->assertSame( 'Bar', $found );
     }
+
+    /**
+     * @ticket 53604
+     */
+    public function test_inner_blocks_excerpt() {
+        $content_1 = '<!-- wp:group -->
+<div class="wp-block-group"><!-- wp:columns -->
+<div class="wp-block-columns"><!-- wp:column -->
+<div class="wp-block-column"><!-- wp:paragraph -->
+<p>Column 1</p>
+<!-- /wp:paragraph --></div>
+<!-- /wp:column -->
+
+<!-- wp:column -->
+<div class="wp-block-column"><!-- wp:paragraph -->
+<p>Column 2</p>
+<!-- /wp:paragraph --></div>
+<!-- /wp:column --></div>
+<!-- /wp:columns --></div>
+<!-- /wp:group -->
+
+<!-- wp:paragraph -->
+<p></p>
+<!-- /wp:paragraph -->';
+
+        $content_2 = '<!-- wp:group -->
+<div class="wp-block-group"><!-- wp:paragraph -->
+<p>Paragraph inside group block</p>
+<!-- /wp:paragraph --></div>
+<!-- /wp:group -->
+
+<!-- wp:paragraph -->
+<p></p>
+<!-- /wp:paragraph -->';
+
+        $post_1 = self::factory()->post->create_and_get(
+            array(
+                'post_content' => $content_1,
+                'post_excerpt' => '',
+            )
+        );
+
+        $post_2 = self::factory()->post->create_and_get(
+            array(
+                'post_content' => $content_2,
+                'post_excerpt' => '',
+            )
+        );
+
+        $this->assertSame(
+            'Column 1 Column 2',
+            get_the_excerpt( ( new WP_Query( array( 'p' => $post_1->ID ) ) )->posts[0] )
+        );
+
+        $this->assertSame(
+            'Paragraph inside group block',
+            get_the_excerpt( ( new WP_Query( array( 'p' => $post_2->ID ) ) )->posts[0] )
+        );
+    }
 }