insert_hooked_blocks_into_rest_response( WP_REST_Response $response, WP_Post $post ): WP_REST_Response

Compatibility

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

Parameters

$responseWP_REST_Response

The response object.

$postWP_Post

Post object.

Return value

WP_REST_Response

The response object.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

7–66

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

Plugin surface

1 hook

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

Called by

1

1 place 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
• querycontent queryget_post()one call below insert_hooked_blocks_into_rest_response()

Further down the call graph this can also reach cache, serialize, option 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 · 11 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while insert_hooked_blocks_into_rest_response() runs, in this order:

1. 1
   apply_filters( the_content )filterline 1566 (+29 into the body)

   Filters the post content.

Uses · 6

• apply_block_hooks_to_content_from_post_object()Run the Block Hooks algorithm on a post object's content.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• has_filter()Checks if any filter has been registered for a hook.
• remove_filter()Removes a callback function from a filter hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• add_filter()Adds a callback function to a filter hook.

Used by · 1

• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.

Source code

View on Trac ↗View on GitHub ↗

1537function insert_hooked_blocks_into_rest_response( $response, $post ) {1538	if ( empty( $response->data['content']['raw'] ) ) {1539		return $response;1540	}1541 1542	$ignored_hooked_blocks_at_root    = array();1543	$response->data['content']['raw'] = apply_block_hooks_to_content_from_post_object(1544		$response->data['content']['raw'],1545		$post,1546		'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata',1547		$ignored_hooked_blocks_at_root1548	);1549 1550	if ( ! empty( $ignored_hooked_blocks_at_root ) ) {1551		$response->data['meta']['_wp_ignored_hooked_blocks'] = wp_json_encode( $ignored_hooked_blocks_at_root );1552	}1553 1554	// If the rendered content was previously empty, we leave it like that.1555	if ( empty( $response->data['content']['rendered'] ) ) {1556		return $response;1557	}1558 1559	// `apply_block_hooks_to_content` is called above. Ensure it is not called again as a filter.1560	$priority = has_filter( 'the_content', 'apply_block_hooks_to_content_from_post_object' );1561	if ( false !== $priority ) {1562		remove_filter( 'the_content', 'apply_block_hooks_to_content_from_post_object', $priority );1563	}1564 1565	/** This filter is documented in wp-includes/post-template.php */1566	$response->data['content']['rendered'] = apply_filters(1567		'the_content',1568		$response->data['content']['raw']1569	);1570 1571	// Restore the filter if it was set initially.1572	if ( false !== $priority ) {1573		add_filter( 'the_content', 'apply_block_hooks_to_content_from_post_object', $priority );1574	}1575 1576	return $response;1577}

Changelog

Introduced in 6.6.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.