WP_Block::render( array $options = array() ): string

Parameters

$optionsarrayoptional

Optional options object.Default: array()

• $dynamicbool

  Defaults to 'true'. Optionally set to false to avoid using the block's render_callback.

Return

string

Rendered block output.

Hooks fired · 6

6 hooks fire while WP_Block::render() runs, in this order:

1. 1
   apply_filters( interactivity_process_directives )filterline 466 (+15 into the body)

   Filters whether Interactivity API should process directives.

2. 2
   apply_filters( pre_render_block )filterline 504 (+53 into the body)

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

3. 3
   apply_filters( render_block_data )filterline 512 (+61 into the body)

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

4. 4
   apply_filters( render_block_context )filterline 515 (+64 into the body)

   Filters the default context provided to a rendered block.

5. 5
   apply_filters( render_block )filterline 584 (+133 into the body)

   Filters the content of a single block.

6. 6
   apply_filters( render_block_{$this->name} )filterline 599 (+148 into the body)

   Filters the content of a single block.

Uses · 8

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_enqueue_script()Enqueues a script.
• wp_enqueue_script_module()Marks the script module to be enqueued in the page.
• wp_enqueue_style()Enqueues a CSS stylesheet.
• wp_interactivity_process_directives()Processes the interactivity directives contained within the HTML content and updates the markup accordingly.
• WP_Block::process_block_bindings()Processes the block bindings and updates the block attributes with the values from the sources.
• WP_Block::replace_html()Depending on the block attribute name, replace its value in the HTML based on the value provided.

Source

View on Trac ↗View on GitHub ↗

451	public function render( $options = array() ) {452		global $post;453 454		/*455		 * There can be only one root interactive block at a time because the rendered HTML of that block contains456		 * the rendered HTML of all its inner blocks, including any interactive block.457		 */458		static $root_interactive_block = null;459		/**460		 * Filters whether Interactivity API should process directives.461		 *462		 * @since 6.6.0463		 *464		 * @param bool $enabled Whether the directives processing is enabled.465		 */466		$interactivity_process_directives_enabled = apply_filters( 'interactivity_process_directives', true );467		if (468			$interactivity_process_directives_enabled && null === $root_interactive_block && (469				( isset( $this->block_type->supports['interactivity'] ) && true === $this->block_type->supports['interactivity'] ) ||470				! empty( $this->block_type->supports['interactivity']['interactive'] )471			)472		) {473			$root_interactive_block = $this;474		}475 476		$options = wp_parse_args(477			$options,478			array(479				'dynamic' => true,480			)481		);482 483		// Process the block bindings and get attributes updated with the values from the sources.484		$computed_attributes = $this->process_block_bindings();485		if ( ! empty( $computed_attributes ) ) {486			// Merge the computed attributes with the original attributes.487			$this->attributes = array_merge( $this->attributes, $computed_attributes );488		}489 490		$is_dynamic    = $options['dynamic'] && $this->name && null !== $this->block_type && $this->block_type->is_dynamic();491		$block_content = '';492 493		if ( ! $options['dynamic'] || empty( $this->block_type->skip_inner_blocks ) ) {494			$index = 0;495 496			foreach ( $this->inner_content as $chunk ) {497				if ( is_string( $chunk ) ) {498					$block_content .= $chunk;499				} else {500					$inner_block  = $this->inner_blocks[ $index ];501					$parent_block = $this;502 503					/** This filter is documented in wp-includes/blocks.php */504					$pre_render = apply_filters( 'pre_render_block', null, $inner_block->parsed_block, $parent_block );505 506					if ( ! is_null( $pre_render ) ) {507						$block_content .= $pre_render;508					} else {509						$source_block = $inner_block->parsed_block;510 511						/** This filter is documented in wp-includes/blocks.php */512						$inner_block->parsed_block = apply_filters( 'render_block_data', $inner_block->parsed_block, $source_block, $parent_block );513 514						/** This filter is documented in wp-includes/blocks.php */515						$inner_block->context = apply_filters( 'render_block_context', $inner_block->context, $inner_block->parsed_block, $parent_block );516 517						$block_content .= $inner_block->render();518					}519 520					++$index;521				}522			}523		}524 525		if ( ! empty( $computed_attributes ) && ! empty( $block_content ) ) {526			foreach ( $computed_attributes as $attribute_name => $source_value ) {527				$block_content = $this->replace_html( $block_content, $attribute_name, $source_value );528			}529		}530

History

Introduced in 5.5.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/class-wp-block.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.