render_block( array $parsed_block ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$parsed_blockarray

An associative array of the block being rendered. See WP_Block_Parser_Block.

• $blockNamestring

  Name of block.

• $attrsarray

  Attributes from block comment delimiters.

• $innerBlocksarray[]

  List of inner blocks. An array of arrays that have the same structure as this one.

• $innerHTMLstring

  HTML from inside block comment delimiters.

• $innerContentarray

  List of string fragments and null markers where inner blocks were found.

Return value

string

String of rendered HTML.

Performance profile

How much work a call to render_block() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

13–44

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 45.

Plugin surface

3 hooks

Third-party callbacks on 'pre_render_block', 'render_block_data', 'render_block_context' run inside this call, and their cost is not bounded by anything here.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost render_block() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while render_block() runs, in this order:

1. 1
   apply_filters( pre_render_block )filterline 2113 (+24 into the body)

   Allows render_block() to be short-circuited, by returning a non-null value.

2. 2
   apply_filters( render_block_data )filterline 2151 (+62 into the body)

   Filters the block being rendered in render_block(), before it's processed.

3. 3
   apply_filters( render_block_context )filterline 2187 (+98 into the body)

   Filters the default context provided to a rendered block.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Block::__construct()Constructor.

Used by · 5

• WP_REST_Block_Renderer_Controller::get_item()Returns block output from block's registered render_callback.
• _excerpt_render_inner_blocks()Renders inner blocks from the allowed wrapper blocks for generating an excerpt.
• do_blocks()Parses dynamic blocks out of `post_content` and re-renders them.
• excerpt_remove_blocks()Parses blocks out of a content string, and renders those appropriate for the excerpt.
• twenty_twenty_one_print_first_instance_of_block()Print the first instance of a block in the content, and then break away.

Source code

View on Trac ↗View on GitHub ↗

2089function render_block( $parsed_block ) {2090	global $post;2091	$parent_block = null;2092 2093	/**2094	 * Allows render_block() to be short-circuited, by returning a non-null value.2095	 *2096	 * @since 5.1.02097	 * @since 5.9.0 The `$parent_block` parameter was added.2098	 *2099	 * @param string|null   $pre_render   The pre-rendered content. Default null.2100	 * @param array         $parsed_block {2101	 *     An associative array of the block being rendered. See WP_Block_Parser_Block.2102	 *2103	 *     @type string   $blockName    Name of block.2104	 *     @type array    $attrs        Attributes from block comment delimiters.2105	 *     @type array[]  $innerBlocks  List of inner blocks. An array of arrays that2106	 *                                  have the same structure as this one.2107	 *     @type string   $innerHTML    HTML from inside block comment delimiters.2108	 *     @type array    $innerContent List of string fragments and null markers where2109	 *                                  inner blocks were found.2110	 * }2111	 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block.2112	 */2113	$pre_render = apply_filters( 'pre_render_block', null, $parsed_block, $parent_block );2114	if ( ! is_null( $pre_render ) ) {2115		return $pre_render;2116	}2117 2118	$source_block = $parsed_block;2119 2120	/**2121	 * Filters the block being rendered in render_block(), before it's processed.2122	 *2123	 * @since 5.1.02124	 * @since 5.9.0 The `$parent_block` parameter was added.2125	 *2126	 * @param array         $parsed_block {2127	 *     An associative array of the block being rendered. See WP_Block_Parser_Block.2128	 *2129	 *     @type string   $blockName    Name of block.2130	 *     @type array    $attrs        Attributes from block comment delimiters.2131	 *     @type array[]  $innerBlocks  List of inner blocks. An array of arrays that2132	 *                                  have the same structure as this one.2133	 *     @type string   $innerHTML    HTML from inside block comment delimiters.2134	 *     @type array    $innerContent List of string fragments and null markers where2135	 *                                  inner blocks were found.2136	 * }2137	 * @param array         $source_block {2138	 *     An un-modified copy of `$parsed_block`, as it appeared in the source content.2139	 *     See WP_Block_Parser_Block.2140	 *2141	 *     @type string   $blockName    Name of block.2142	 *     @type array    $attrs        Attributes from block comment delimiters.2143	 *     @type array[]  $innerBlocks  List of inner blocks. An array of arrays that2144	 *                                  have the same structure as this one.2145	 *     @type string   $innerHTML    HTML from inside block comment delimiters.2146	 *     @type array    $innerContent List of string fragments and null markers where2147	 *                                  inner blocks were found.2148	 * }2149	 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block.2150	 */2151	$parsed_block = apply_filters( 'render_block_data', $parsed_block, $source_block, $parent_block );2152 2153	$context = array();2154 2155	if ( $post instanceof WP_Post ) {2156		$context['postId'] = $post->ID;2157 2158		/*2159		 * The `postType` context is largely unnecessary server-side, since the ID2160		 * is usually sufficient on its own. That being said, since a block's2161		 * manifest is expected to be shared between the server and the client,2162		 * it should be included to consistently fulfill the expectation.2163		 */2164		$context['postType'] = $post->post_type;2165	}2166 2167	/**2168	 * Filters the default context provided to a rendered block.

Changelog

Introduced in 5.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/blocks.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.