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

Parameters

$block_namestring|null

Block name. Null if the block name is unknown, e.g. Classic blocks have their name set to null.

$block_attributesarray

Block attributes.

$block_contentstring

Block save content.

Return

string

Comment-delimited block content.

Uses · 2

• strip_core_block_namespace()Returns the block name to use for serialization. This will remove the default "core/" namespace from a block name.
• serialize_block_attributes()Given an array of attributes, returns a string in the serialized attributes format prepared for post content.

Used by · 7

• _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.
• inject_ignored_hooked_blocks_metadata_attributes()Inject ignoredHookedBlocks metadata attributes into a template or template part.
• serialize_block()Returns the content of a block, including comment delimiters, serializing all attributes from the given parsed block.
• traverse_and_serialize_block()Traverses a parsed block tree and applies callbacks before and after serializing it.
• 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 ↗

1644function get_comment_delimited_block_content( $block_name, $block_attributes, $block_content ) {1645	if ( is_null( $block_name ) ) {1646		return $block_content;1647	}1648 1649	$serialized_block_name = strip_core_block_namespace( $block_name );1650	$serialized_attributes = empty( $block_attributes ) ? '' : serialize_block_attributes( $block_attributes ) . ' ';1651 1652	if ( empty( $block_content ) ) {1653		return sprintf( '<!-- wp:%s %s/-->', $serialized_block_name, $serialized_attributes );1654	}1655 1656	return sprintf(1657		'<!-- wp:%s %s-->%s<!-- /wp:%s -->',1658		$serialized_block_name,1659		$serialized_attributes,1660		$block_content,1661		$serialized_block_name1662	);1663}

History

Introduced in 5.3.1. 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.8.8 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.