WP_Block::render( array $options = array() ): 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

$optionsarrayoptional

Optional options object.Default: array()

• $dynamicbool

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

Return value

string

Rendered block output.

Performance profile

How much work a call to WP_Block::render() 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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

107–166

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

Plugin surface

7 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 7

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

1. 1
   apply_filters( interactivity_process_directives )filterline 517 (+22 into the body)

   Filters whether Interactivity API should process directives.

2. 2
   apply_filters( pre_render_block )filterline 555 (+60 into the body)

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

3. 3
   apply_filters( render_block_data )filterline 564 (+69 into the body)

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

4. 4
   apply_filters( render_block_context )filterline 567 (+72 into the body)

   Filters the default context provided to a rendered block.

5. 5
   apply_filters( render_block )filterline 651 (+156 into the body)

   Filters the content of a single block.

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

   Filters the content of a single block.

7. 7
   apply_filters( enqueue_empty_block_content_assets )filterline 704 (+209 into the body)

   Filters whether to enqueue assets for a block which has no rendered content.

Uses · 16

• did_action()Retrieves the number of times an action has been fired during the current request.
• wp_styles()Initializes $wp_styles if it has not been set.
• wp_scripts()Initializes $wp_scripts if it has not been set.
• wp_script_modules()Retrieves the main WP_Script_Modules instance.
• 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_dequeue_style()Removes a previously enqueued CSS stylesheet.
• wp_dequeue_script()Removes a previously enqueued script.

Source code

View on Trac ↗View on GitHub ↗

495	public function render( $options = array() ) {496		global $post;497 498		$before_wp_enqueue_scripts_count = did_action( 'wp_enqueue_scripts' );499 500		// Capture the current assets queues.501		$before_styles_queue         = wp_styles()->queue;502		$before_scripts_queue        = wp_scripts()->queue;503		$before_script_modules_queue = wp_script_modules()->get_queue();504 505		/*506		 * There can be only one root interactive block at a time because the rendered HTML of that block contains507		 * the rendered HTML of all its inner blocks, including any interactive block.508		 */509		static $root_interactive_block = null;510		/**511		 * Filters whether Interactivity API should process directives.512		 *513		 * @since 6.6.0514		 *515		 * @param bool $enabled Whether the directives processing is enabled.516		 */517		$interactivity_process_directives_enabled = apply_filters( 'interactivity_process_directives', true );518		if (519			$interactivity_process_directives_enabled && null === $root_interactive_block && (520				( isset( $this->block_type->supports['interactivity'] ) && true === $this->block_type->supports['interactivity'] ) ||521				! empty( $this->block_type->supports['interactivity']['interactive'] )522			)523		) {524			$root_interactive_block = $this;525		}526 527		$options = wp_parse_args(528			$options,529			array(530				'dynamic' => true,531			)532		);533 534		// Process the block bindings and get attributes updated with the values from the sources.535		$computed_attributes = $this->process_block_bindings();536		if ( ! empty( $computed_attributes ) ) {537			// Merge the computed attributes with the original attributes.538			$this->attributes = array_merge( $this->attributes, $computed_attributes );539		}540 541		$is_dynamic    = $options['dynamic'] && $this->name && null !== $this->block_type && $this->block_type->is_dynamic();542		$block_content = '';543 544		if ( ! $options['dynamic'] || empty( $this->block_type->skip_inner_blocks ) ) {545			$index = 0;546 547			foreach ( $this->inner_content as $chunk ) {548				if ( is_string( $chunk ) ) {549					$block_content .= $chunk;550				} else {551					$inner_block  = $this->inner_blocks[ $index ];552					$parent_block = $this;553 554					/** This filter is documented in wp-includes/blocks.php */555					$pre_render = apply_filters( 'pre_render_block', null, $inner_block->parsed_block, $parent_block );556 557					if ( ! is_null( $pre_render ) ) {558						$block_content .= $pre_render;559					} else {560						$source_block        = $inner_block->parsed_block;561						$inner_block_context = $inner_block->context;562 563						/** This filter is documented in wp-includes/blocks.php */564						$inner_block->parsed_block = apply_filters( 'render_block_data', $inner_block->parsed_block, $source_block, $parent_block );565 566						/** This filter is documented in wp-includes/blocks.php */567						$inner_block->context = apply_filters( 'render_block_context', $inner_block->context, $inner_block->parsed_block, $parent_block );568 569						/*570						 * The `refresh_context_dependents()` method already calls `refresh_parsed_block_dependents()`.571						 * Therefore the second condition is irrelevant if the first one is satisfied.572						 */573						if ( $inner_block->context !== $inner_block_context ) {574							$inner_block->refresh_context_dependents();

Changelog

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