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

Parameters

$contentstring

Serialized content.

$contextWP_Block_Template|WP_Post|array|nulloptional

A block template, template part, post object, or pattern that the blocks belong to. If set to null, get_post() will be called to use the current post as context. Default: null.Default: null

$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

string

The serialized markup.

Uses · 13

• get_post()Retrieves post data given a post ID or post object.
• 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()

Used by · 9

• 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.
• apply_block_hooks_to_content_from_post_object()Run the Block Hooks algorithm on a post object's content.
• get_block_file_template()Retrieves a unified template object based on a theme file or plugin registration.
• get_block_templates()Retrieves a list of unified template objects based on a query.
• inject_ignored_hooked_blocks_metadata_attributes()Inject ignoredHookedBlocks metadata attributes into a template or template part.
• 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

View on Trac ↗View on GitHub ↗

1104function apply_block_hooks_to_content( $content, $context = null, $callback = 'insert_hooked_blocks' ) {1105	// Default to the current post if no context is provided.1106	if ( null === $context ) {1107		$context = get_post();1108	}1109 1110	$hooked_blocks = get_hooked_blocks();1111 1112	$before_block_visitor = '_inject_theme_attribute_in_template_part_block';1113	$after_block_visitor  = null;1114	if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {1115		$before_block_visitor = make_before_block_visitor( $hooked_blocks, $context, $callback );1116		$after_block_visitor  = make_after_block_visitor( $hooked_blocks, $context, $callback );1117	}1118 1119	$block_allows_multiple_instances = array();1120	/*1121	 * Remove hooked blocks from `$hooked_block_types` if they have `multiple` set to false and1122	 * are already present in `$content`.1123	 */1124	foreach ( $hooked_blocks as $anchor_block_type => $relative_positions ) {1125		foreach ( $relative_positions as $relative_position => $hooked_block_types ) {1126			foreach ( $hooked_block_types as $index => $hooked_block_type ) {1127				$hooked_block_type_definition =1128					WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );1129 1130				$block_allows_multiple_instances[ $hooked_block_type ] =1131					block_has_support( $hooked_block_type_definition, 'multiple', true );1132 1133				if (1134					! $block_allows_multiple_instances[ $hooked_block_type ] &&1135					has_block( $hooked_block_type, $content )1136				) {1137					unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ][ $index ] );1138				}1139			}1140			if ( empty( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) ) {1141				unset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] );1142			}1143		}1144		if ( empty( $hooked_blocks[ $anchor_block_type ] ) ) {1145			unset( $hooked_blocks[ $anchor_block_type ] );1146		}1147	}1148 1149	/*1150	 * We also need to cover the case where the hooked block is not present in1151	 * `$content` at first and we're allowed to insert it once -- but not again.1152	 */1153	$suppress_single_instance_blocks = static function ( $hooked_block_types ) use ( &$block_allows_multiple_instances, $content ) {1154		static $single_instance_blocks_present_in_content = array();1155		foreach ( $hooked_block_types as $index => $hooked_block_type ) {1156			if ( ! isset( $block_allows_multiple_instances[ $hooked_block_type ] ) ) {1157				$hooked_block_type_definition =1158					WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );1159 1160				$block_allows_multiple_instances[ $hooked_block_type ] =1161					block_has_support( $hooked_block_type_definition, 'multiple', true );1162			}1163 1164			if ( $block_allows_multiple_instances[ $hooked_block_type ] ) {1165				continue;1166			}1167 1168			// The block doesn't allow multiple instances, so we need to check if it's already present.1169			if (1170				in_array( $hooked_block_type, $single_instance_blocks_present_in_content, true ) ||1171				has_block( $hooked_block_type, $content )1172			) {1173				unset( $hooked_block_types[ $index ] );1174			} else {1175				// We can insert the block once, but need to remember not to insert it again.1176				$single_instance_blocks_present_in_content[] = $hooked_block_type;1177			}1178		}1179		return $hooked_block_types;1180	};1181	add_filter( 'hooked_block_types', $suppress_single_instance_blocks, PHP_INT_MAX );1182	$content = traverse_and_serialize_blocks(1183		parse_blocks( $content ),

History

Introduced in 6.6.0. One change between 6.7.7 and 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/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.