render_block( array $parsed_block ): string

Parameters

$parsed_blockarray

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

• $blockNamestring|null

  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

string

String of rendered HTML.

Hooks fired · 3

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

1. 1
   apply_filters( pre_render_block )filterline 2436 (+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 2474 (+62 into the body)

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

3. 3
   apply_filters( render_block_context )filterline 2510 (+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()Prints the first instance of a block in the content, and then break away.

Source

View on Trac ↗View on GitHub ↗

2412function render_block( $parsed_block ) {2413	global $post;2414	$parent_block = null;2415 2416	/**2417	 * Allows render_block() to be short-circuited, by returning a non-null value.2418	 *2419	 * @since 5.1.02420	 * @since 5.9.0 The `$parent_block` parameter was added.2421	 *2422	 * @param string|null   $pre_render   The pre-rendered content. Default null.2423	 * @param array         $parsed_block {2424	 *     An associative array of the block being rendered. See WP_Block_Parser_Block.2425	 *2426	 *     @type string|null $blockName    Name of block.2427	 *     @type array       $attrs        Attributes from block comment delimiters.2428	 *     @type array[]     $innerBlocks  List of inner blocks. An array of arrays that2429	 *                                     have the same structure as this one.2430	 *     @type string      $innerHTML    HTML from inside block comment delimiters.2431	 *     @type array       $innerContent List of string fragments and null markers where2432	 *                                     inner blocks were found.2433	 * }2434	 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block.2435	 */2436	$pre_render = apply_filters( 'pre_render_block', null, $parsed_block, $parent_block );2437	if ( ! is_null( $pre_render ) ) {2438		return $pre_render;2439	}2440 2441	$source_block = $parsed_block;2442 2443	/**2444	 * Filters the block being rendered in render_block(), before it's processed.2445	 *2446	 * @since 5.1.02447	 * @since 5.9.0 The `$parent_block` parameter was added.2448	 *2449	 * @param array         $parsed_block {2450	 *     An associative array of the block being rendered. See WP_Block_Parser_Block.2451	 *2452	 *     @type string|null $blockName    Name of block.2453	 *     @type array       $attrs        Attributes from block comment delimiters.2454	 *     @type array[]     $innerBlocks  List of inner blocks. An array of arrays that2455	 *                                     have the same structure as this one.2456	 *     @type string      $innerHTML    HTML from inside block comment delimiters.2457	 *     @type array       $innerContent List of string fragments and null markers where2458	 *                                     inner blocks were found.2459	 * }2460	 * @param array         $source_block {2461	 *     An un-modified copy of `$parsed_block`, as it appeared in the source content.2462	 *     See WP_Block_Parser_Block.2463	 *2464	 *     @type string|null $blockName    Name of block.2465	 *     @type array       $attrs        Attributes from block comment delimiters.2466	 *     @type array[]     $innerBlocks  List of inner blocks. An array of arrays that2467	 *                                     have the same structure as this one.2468	 *     @type string      $innerHTML    HTML from inside block comment delimiters.2469	 *     @type array       $innerContent List of string fragments and null markers where2470	 *                                     inner blocks were found.2471	 * }2472	 * @param WP_Block|null $parent_block If this is a nested block, a reference to the parent block.2473	 */2474	$parsed_block = apply_filters( 'render_block_data', $parsed_block, $source_block, $parent_block );2475 2476	$context = array();2477 2478	if ( $post instanceof WP_Post ) {2479		$context['postId'] = $post->ID;2480 2481		/*2482		 * The `postType` context is largely unnecessary server-side, since the ID2483		 * is usually sufficient on its own. That being said, since a block's2484		 * manifest is expected to be shared between the server and the client,2485		 * it should be included to consistently fulfill the expectation.2486		 */2487		$context['postType'] = $post->post_type;2488	}2489 2490	/**2491	 * Filters the default context provided to a rendered block.

History

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 7.1.0 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.