has_block() – Determine whether a $post or a string contains a specific block type.

You appear to be a bot. Output may be restricted

Description

Determines whether a $post or a string contains a specific block type.

This test optimizes for performance rather than strict accuracy, detecting whether the block type exists but not validating its structure and not checking reusable blocks. For strict accuracy, you should use the block parser on post content.

Usage

$bool = has_block( $block_name, $post );

Parameters

$block_name
( string ) required – Full block type to look for.
$post
( int|string|WP_Post|null ) optional – Optional. Post content, post ID, or post object. Defaults to global $post.

Returns

bool Whether the post content contains the specified block.

Source

File name: wordpress/wp-includes/blocks.php
Lines:

1 to 37 of 37
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;
}
 

 View on GitHub View on Trac