has_block( string $block_name, int|string|WP_Post|null $post = null )
Determine whether a $post or a string contains a specific block type.
Contents
Description Description
This test optimizes for performance rather than strict accuracy, detecting the block type exists but not validating its structure. For strict accuracy, you should use the block parser on post content.
See also See also
Parameters Parameters
- $block_name
-
(string) (Required) Full Block type to look for.
- $post
-
(int|string|WP_Post|null) (Optional) Post content, post ID, or post object. Defaults to global $post.
Default value: null
Return Return
(bool) Whether the post content contains the specified block.
Source Source
File: wp-includes/blocks.php
function has_block( $block_name, $post = null ) {
if ( ! has_blocks( $post ) ) {
return false;
}
if ( ! is_string( $post ) ) {
$wp_post = get_post( $post );
if ( $wp_post instanceof WP_Post ) {
$post = $wp_post->post_content;
}
}
/*
* Normalize block name to include namespace, if provided as non-namespaced.
* This matches behavior for WordPress 5.0.0 - 5.3.0 in matching blocks by
* their serialized names.
*/
if ( false === strpos( $block_name, '/' ) ) {
$block_name = 'core/' . $block_name;
}
// Test for existence of block by its fully qualified name.
$has_block = false !== strpos( $post, '<!-- wp:' . $block_name . ' ' );
if ( ! $has_block ) {
/*
* If the given block name would serialize to a different name, test for
* existence by the serialized form.
*/
$serialized_block_name = strip_core_block_namespace( $block_name );
if ( $serialized_block_name !== $block_name ) {
$has_block = false !== strpos( $post, '<!-- wp:' . $serialized_block_name . ' ' );
}
}
return $has_block;
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
// Note: does not support arrays if ( has_block( array( 'gallery', 'button' ) ) ) { // error } // Use || instead if ( has_block( 'gallery' ) || has_block( 'button' ) ) { // Do something. }If adding a “number” value for $post make sure it’s an integer (if a string – like ‘5’) sneaks in you will get a return of false.
If you are wanting to check if a custom (non core block) is for a page or post, include the namespace/name-of-block:
if ( has_block( 'my-namespace/block-name' ) ) { // Do stuff here. }if ( has_block( 'gallery' ) ) { // Do something. }