has_blocks() – Function | Developer.WordPress.org

Determines whether a post or content string has blocks.

Description

This test optimizes for performance rather than strict accuracy, detecting the pattern of a block but not validating its structure. For strict accuracy, you should use the block parser on post content.

Parameters

$postint|string|WP_Post|nulloptional: Post content, post ID, or post object.
Defaults to global $post.
Default:null

Return

bool Whether the post has blocks.

Source

function has_blocks( $post = null ) {
	if ( ! is_string( $post ) ) {
		$wp_post = get_post( $post );

		if ( ! $wp_post instanceof WP_Post ) {
			return false;
		}

		$post = $wp_post->post_content;
	}

	return str_contains( (string) $post, '<!-- wp:' );
}

View all references View on Trac View on GitHub

Uses	Description
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Used by	Description
block_version()`wp-includes/blocks.php`	Returns the current version of the block format that the content string is using.
do_blocks()`wp-includes/blocks.php`	Parses dynamic blocks out of `post_content` and re-renders them.
has_block()`wp-includes/blocks.php`	Determines whether a $post or a string contains a specific block type.
excerpt_remove_blocks()`wp-includes/blocks.php`	Parses blocks out of a content string, and renders those appropriate for the excerpt.
_WP_Editors::parse_settings()`wp-includes/class-wp-editor.php`	Parse default arguments for the editor instance.

Changelog

Version	Description
5.0.0	Introduced.

User Contributed Notes

Skip to note 3 content

Nilambar Sharma 5 years ago

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
```
if ( has_blocks() ) {
    // Do something.
}
```
Log in to add feedback
Skip to note 4 content

Ankit Gade 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
1. We can use this function to pass a flag to indicate if content has blocks when we have decoupled environment, where WP is backend and frontend is implemented in some other language.

2. We can convert (parse) block output as per our requirement and pass it in the API. While, converting it can be useful to check if the content has any block. This will let us pass content efficiently by implementing parsing when it is necessary.
```
class WPDocs_Custom_Block_Parse {

	function parse() {
		// Do something
  	}
}

function wpdocs_custom_block_parser() {
	return 'WPDocs_Custom_Block_Parse';
}

/**
 * In the implementation check if content has block
 */
if ( has_blocks( $post_content ) ) {
	add_filter( 'block_parser_class', 'wpdocs_custom_block_parser' );
	$response_content = parse_blocks( $content );
	remove_filter( 'block_parser_class', 'wpdocs_custom_block_parser' );
}
```
Log in to add feedback

has_blocks( int|string|WP_Post|null $post = null ): bool

In this article