WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

serialize_block()

serialize_block( array $block ): string

In this article

Back to top

Returns the content of a block, including comment delimiters, serializing all attributes from the given parsed block.

Description

This should be used when preparing a block to be saved to post content.
Prefer render_block when preparing a block for display. Unlike render_block, this does not evaluate a block’s render_callback, and will instead preserve the markup as parsed.

Parameters

$blockarrayrequired
A representative array of a single parsed block object. See WP_Block_Parser_Block.
  • blockName string
    Name of block.
  • attrs array
    Attributes from block comment delimiters.
  • innerBlocks array[]
    List of inner blocks. An array of arrays that have the same structure as this one.
  • innerHTML string
    HTML from inside block comment delimiters.
  • innerContent array
    List of string fragments and null markers where inner blocks were found.

Return

string String of rendered HTML.

Source

function serialize_block( $block ) {
	$block_content = '';

	$index = 0;
	foreach ( $block['innerContent'] as $chunk ) {
		$block_content .= is_string( $chunk ) ? $chunk : serialize_block( $block['innerBlocks'][ $index++ ] );
	}

	if ( ! is_array( $block['attrs'] ) ) {
		$block['attrs'] = array();
	}

	return get_comment_delimited_block_content(
		$block['blockName'],
		$block['attrs'],
		$block_content
	);
}

View all references View on Trac View on GitHub

UsesDescription
serialize_block()wp-includes/blocks.php

Returns the content of a block, including comment delimiters, serializing all attributes from the given parsed block.

get_comment_delimited_block_content()wp-includes/blocks.php

Returns the content of a block, including comment delimiters.

Used byDescription
insert_hooked_blocks()wp-includes/blocks.php

Returns the markup for blocks hooked to the given anchor block in a specific relative position.

_inject_theme_attribute_in_block_template_content()wp-includes/deprecated.php

Parses wp_template content and injects the active theme’s stylesheet as a theme attribute into each wp_template_part

_remove_theme_attribute_in_block_template_content()wp-includes/deprecated.php

Parses a block template and removes the theme attribute from each template part.

filter_block_content()wp-includes/blocks.php

Filters and sanitizes block content to remove non-allowable HTML from parsed block attribute values.

serialize_block()wp-includes/blocks.php

Returns the content of a block, including comment delimiters, serializing all attributes from the given parsed block.

Changelog

VersionDescription
5.3.1Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Muhammad Saqib Sarwar
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    A sample code to understand how this works. I am using https://developer.wordpress.org/cli/commands/eval-file/ to execute this.

    /*
 * Create a block programmatically and serialize it.
 */
$block_name = 'core/paragraph';
$innerHTML  = 'Sample paragraph text.';

$converted_block = new WP_Block_Parser_Block( $block_name, array(), array(), $innerHTML, array( $innerHTML ) );
WP_CLI::log( print_r( $converted_block, true ) );

$serialized_block = serialize_block( (array) $converted_block );
WP_CLI::log( $serialized_block );

You must log in before being able to contribute a note or feedback.