apply_block_hooks_to_content( string $content, WP_Block_Template|WP_Post|array $context, callable $callback = 'insert_hooked_blocks' ): string

Compatibility

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

Parameters

$contentstring

Serialized content.

$contextWP_Block_Template|WP_Post|array

A block template, template part, wp_navigation post object, or pattern that the blocks belong to.

$callbackcallableoptional

A function that will be called for each block to generate the markup for a given list of blocks that are hooked to it.
Default: 'insert_hooked_blocks'.Default: 'insert_hooked_blocks'

Return value

string

The serialized markup.

Performance profile

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

Scales with input

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

Instructions

7–8

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

8

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

What it touches

• querycontent queryget_post()one call below apply_block_hooks_to_content()
• hookthird-party callbacksapply_filters()one call below apply_block_hooks_to_content()

Further down the call graph this can also reach 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 · 1 distinct outcome

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

Uses · 12

• get_hooked_blocks()Retrieves block types hooked into the given block, grouped by anchor block type and the relative position.
• has_filter()Checks if any filter has been registered for a hook.
• make_before_block_visitor()Returns a function that injects the theme attribute into, and hooked blocks before, a given block.
• make_after_block_visitor()Returns a function that injects the hooked blocks after a given block.
• block_has_support()Checks whether the current block type supports the feature requested.
• has_block()Determines whether a $post or a string contains a specific block type.
• add_filter()Adds a callback function to a filter hook.
• traverse_and_serialize_blocks()Given an array of parsed block trees, applies callbacks before and after serializing them and returns their concatenated output.
• parse_blocks()Parses blocks out of a content string.
• remove_filter()Removes a callback function from a filter hook.
• WP_Block_Type_Registry::get_instance()::get_registered()
• WP_Block_Type_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 8

• WP_Block_Patterns_Registry::get_all_registered()Retrieves all registered block patterns.
• WP_Block_Patterns_Registry::get_registered()Retrieves an array containing the properties of a registered block pattern.
• _build_block_template_result_from_file()Builds a unified template object based on a theme file.
• _build_block_template_result_from_post()Builds a unified template object based a post Object.
• block_core_navigation_insert_hooked_blocks()Insert hooked blocks into a Navigation block.
• inject_ignored_hooked_blocks_metadata_attributes()Inject ignoredHookedBlocks metadata attributes into a template or template part.
• insert_hooked_blocks_into_rest_response()Hooks into the REST API response for the core/navigation block and adds the first and last inner blocks.
• update_ignored_hooked_blocks_postmeta()Updates the wp_postmeta with the list of ignored hooked blocks where the inner blocks are stored as post content.

Source code

View on Trac ↗View on GitHub ↗

1052function apply_block_hooks_to_content( $content, $context, $callback = 'insert_hooked_blocks' ) {1053	$hooked_blocks = get_hooked_blocks();1054 1055	$before_block_visitor = '_inject_theme_attribute_in_template_part_block';1056	$after_block_visitor  = null;1057	if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {1058		$before_block_visitor = make_before_block_visitor( $hooked_blocks, $context, $callback );1059		$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $context, $callback );1060	}1061 1062	$block_allows_multiple_instances = array();1063	/*1064	 * Remove hooked blocks from `$hooked_block_types` if they have `multiple` set to false and1065	 * are already present in `$content`.1066	 */1067	foreach ( $hooked_blocks as $anchor_block_type => $relative_positions ) {1068		foreach ( $relative_positions as $relative_position => $hooked_block_types ) {1069			foreach ( $hooked_block_types as $index => $hooked_block_type ) {1070				$hooked_block_type_definition =1071					WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );1072 1073				$block_allows_multiple_instances[ $hooked_block_type ] =1074					block_has_support( $hooked_block_type_definition, 'multiple', true );1075 1076				if (1077					! $block_allows_multiple_instances[ $hooked_block_type ] &&1078					has_block( $hooked_block_type, $content )1079				) {1080					unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ][ $index ] );1081				}1082			}1083			if ( empty( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) ) {1084				unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] );1085			}1086		}1087		if ( empty( $hooked_blocks[ $anchor_block_type ] ) ) {1088			unset( $hooked_blocks[ $anchor_block_type ] );1089		}1090	}1091 1092	/*1093	 * We also need to cover the case where the hooked block is not present in1094	 * `$content` at first and we're allowed to insert it once -- but not again.1095	 */1096	$suppress_single_instance_blocks = static function ( $hooked_block_types ) use ( &$block_allows_multiple_instances, $content ) {1097		static $single_instance_blocks_present_in_content = array();1098		foreach ( $hooked_block_types as $index => $hooked_block_type ) {1099			if ( ! isset( $block_allows_multiple_instances[ $hooked_block_type ] ) ) {1100				$hooked_block_type_definition =1101					WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );1102 1103				$block_allows_multiple_instances[ $hooked_block_type ] =1104					block_has_support( $hooked_block_type_definition, 'multiple', true );1105			}1106 1107			if ( $block_allows_multiple_instances[ $hooked_block_type ] ) {1108				continue;1109			}1110 1111			// The block doesn't allow multiple instances, so we need to check if it's already present.1112			if (1113				in_array( $hooked_block_type, $single_instance_blocks_present_in_content, true ) ||1114				has_block( $hooked_block_type, $content )1115			) {1116				unset( $hooked_block_types[ $index ] );1117			} else {1118				// We can insert the block once, but need to remember not to insert it again.1119				$single_instance_blocks_present_in_content[] = $hooked_block_type;1120			}1121		}1122		return $hooked_block_types;1123	};1124	add_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );1125	$content = traverse_and_serialize_blocks(1126		parse_blocks( $content ),1127		$before_block_visitor,1128		$after_block_visitor1129	);1130	remove_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );1131

Changelog

Introduced in 6.6.0. One change between 6.7.10 and 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 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.