get_comment_delimited_block_content() – Function

Returns the content of a block, including comment delimiters.

Parameters

$block_namestring|nullrequired: Block name. Null if the block name is unknown, e.g. Classic blocks have their name set to null.
$block_attributesarrayrequired: Block attributes.
$block_contentstringrequired: Block save content.

Return

string Comment-delimited block content.

Source

function get_comment_delimited_block_content( $block_name, $block_attributes, $block_content ) {
	if ( is_null( $block_name ) ) {
		return $block_content;
	}

	$serialized_block_name = strip_core_block_namespace( $block_name );
	$serialized_attributes = empty( $block_attributes ) ? '' : serialize_block_attributes( $block_attributes ) . ' ';

	if ( empty( $block_content ) ) {
		return sprintf( '<!-- wp:%s %s/-->', $serialized_block_name, $serialized_attributes );
	}

	return sprintf(
		'<!-- wp:%s %s-->%s<!-- /wp:%s -->',
		$serialized_block_name,
		$serialized_attributes,
		$block_content,
		$serialized_block_name
	);
}

View all references View on Trac View on GitHub

Uses	Description
strip_core_block_namespace()`wp-includes/blocks.php`	Returns the block name to use for serialization. This will remove the default “core/” namespace from a block name.
serialize_block_attributes()`wp-includes/blocks.php`	Given an array of attributes, returns a string in the serialized attributes format prepared for post content.

Used by	Description
apply_block_hooks_to_content_from_post_object()`wp-includes/blocks.php`	Run the Block Hooks algorithm on a post object’s content.
update_ignored_hooked_blocks_postmeta()`wp-includes/blocks.php`	Updates the wp_postmeta with the list of ignored hooked blocks where the inner blocks are stored as post content.
inject_ignored_hooked_blocks_metadata_attributes()`wp-includes/block-template-utils.php`	Inject ignoredHookedBlocks metadata attributes into a template or template part.
traverse_and_serialize_block()`wp-includes/blocks.php`	Traverses a parsed block tree and applies callbacks before and after serializing it.
_build_block_template_result_from_file()`wp-includes/block-template-utils.php`	Builds a unified template object based on a theme file.
_build_block_template_result_from_post()`wp-includes/block-template-utils.php`	Builds a unified template object based a post Object.
serialize_block()`wp-includes/blocks.php`	Returns the content of a block, including comment delimiters, serializing all attributes from the given parsed block.

Show 2 more Show less

Changelog

Version	Description
5.3.1	Introduced.

get_comment_delimited_block_content( string|null $block_name, array $block_attributes, string $block_content ): string

In this article

Parameters

Return

Source

Changelog

User Contributed Notes

get_comment_delimited_block_content( string|null $block_name, array $block_attributes, string $block_content ): string

In this article

Parameters

Return

Source

Related

Changelog

User Contributed Notes