Pass the block name to the render callback

[johnbillion]

Issue Overview

The block name is not passed as a parameter to the render_callback callback function. This means it's not possible to use a generic callback which performs routing to render dynamic blocks (for example, a generic handler which routes block rendering to theme template parts).

Expected Behavior

The block name is passed as a parameter to the render_callback callback function.

Current Behavior

Just the block attributes and content are passed.

[benlk]

There are a number of "convert your shortcode to a block" tutorials that use the shortcode callback as the render_callback function, which is conveniently possible because the two callbacks share function signatures.

• shortcode_callback( $attributes, $content, $shortcode_tag );
  • $attributes: an array of attributes
  • $content: the content wrapped in the shortcode tag
  • the entire shortcode tag
• render_callback( $attributes, $content );

So there's three easy solutions:

1. Pass the block name as a reserved array key in $attributes
2. Pass the block comment-plus-contents as the third parameter of the render callback
3. Pass the block name as the third parameter of the render callback

[carnilino]

You can pass block name via attributes using filter in php's render_block function.

function pass_block_name_to_render( $block, $source_block ) {
	$block['attrs']['_name'] = $block['blockName'];
	return $block;
}

add_action( 'render_block_data', 'pass_block_name_to_render', 10, 2 );

You can then access it in the render callback like this: $attributes['_name']

[aduth]

A possible solution to this is being explored at #21467 (comment) , where render_callback would be provided an instance of a block class containing all properties relevant to that block (including name), while still retaining backwards-compatibility by having the class implement ArrayAccess so that array access is treated as it behaves today with retrieving attributes of the block.

These would both work, and effectively behave the same:

register_block_type( 'my-plugin/favorite-color', [
    'render_callback' => function( $block_attributes ) {
        return 'Favorite color is: ' . esc_html( $block_attributes['color'] );
    }
] );

register_block_type( 'my-plugin/favorite-color', [
    'render_callback' => function( $block ) {
        return 'Favorite color is: ' . esc_html( $block->attributes['color'] );
    }
] );

It's still an early iteration, but feedback is welcome.

[aduth]

This is now possible as of the changes merged in #21467.

See documentation: https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/developers/tutorials/block-tutorial/creating-dynamic-blocks.md

Example:

register_block_type( 'my-plugin/favorite-color', [
    'render_callback' => function( $block ) {
        return 'Block name: ' . esc_html( $block->name );
    }
] );

[vena]

is there a current method now that the render_callback only receives an attributes array? $block->name only throws an error.

[bph]

The above documentation about creating dynamic blocks has moved to https://github.com/WordPress/gutenberg/blob/trunk/docs/how-to-guides/block-tutorial/creating-dynamic-blocks.md

[vena]

Thank you, I had found the new location earlier... but the problem is the render_callback no longer appears to receive a WP_Block instance which was relevant to resolving this issue.