Changeset 50123

Timestamp:

02/01/2021 06:04:36 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Editor: Introduce a dynamic filter for the content of a single block:

render_block_{$this->name}

This complements the existing render_block hook and allows for filtering the content of a specific block without having to use conditionals inside the filter callback.

Props manzoorwani.jk, noisysocks, birgire, johnbillion.
Fixes #46187.

Location:

trunk

Files:

• src/wp-includes/class-wp-block.php (modified) (1 diff)
• tests/phpunit/tests/blocks/block.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-block.php

@@ -242 +242 @@
                  * @param array  $block         The full block, including name and attributes.
                  */
-                return apply_filters( 'render_block', $block_content, $this->parsed_block );
+                $block_content = apply_filters( 'render_block', $block_content, $this->parsed_block );
+
+                /**
+                 * Filters the content of a single block.
+                 *
+                 * The dynamic portion of the hook name, `$name`, refers to
+                 * the block name, e.g. "core/paragraph".
+                 *
+                 * @since 5.7.0
+                 *
+                 * @param string $block_content The block content about to be appended.
+                 * @param array  $block         The full block, including name and attributes.
+                 */
+                $block_content = apply_filters( "render_block_{$this->name}", $block_content, $this->parsed_block );
+
+                return $block_content;
         }
 

trunk/tests/phpunit/tests/blocks/block.php

@@ -329 +329 @@
 
                 $this->assertSame( 'Original: "StaticOriginal: "Inner", from block "core/example"", from block "core/example"', $rendered_content );
-
+        }
+
+        /**
+         * @ticket 46187
+         */
+        function test_render_applies_dynamic_render_block_filter() {
+                $this->registry->register( 'core/example', array() );
+
+                add_filter( 'render_block_core/example', array( $this, 'filter_render_block' ), 10, 2 );
+
+                $parsed_blocks = parse_blocks( '<!-- wp:example -->Static<!-- wp:example -->Inner<!-- /wp:example --><!-- /wp:example -->' );
+                $parsed_block  = $parsed_blocks[0];
+                $context       = array();
+                $block         = new WP_Block( $parsed_block, $context, $this->registry );
+
+                $rendered_content = $block->render();
+
+                remove_filter( 'render_block_core/example', array( $this, 'filter_render_block' ) );
+
+                $this->assertSame( 'Original: "StaticOriginal: "Inner", from block "core/example"", from block "core/example"', $rendered_content );
         }