3773 add has block functions

lib/blocks.php

@@ -208,3 +208,55 @@ function do_blocks( $content ) {
 	return $rendered_content;
 }
 add_filter( 'the_content', 'do_blocks', 9 ); // BEFORE do_shortcode().
+
+/**
+ * Determine whether a post has a specific block. This test optimizes for
+ * performance rather than strict accuracy, detecting the pattern of a block type
+ * but not validating its structure. For strict accuracy, you should use the
+ * block parser on post content.
+ *
+ * @see gutenberg_parse_blocks()
+ *
+ * @since 3.4
+ *
+ * @param string $block_name Full Block name to look for.
+ * @param object $post Post.
+ * @return bool Whether the content contain the specified block.
+ */
+function gutenberg_post_has_block( $block_name, $post = null ) {
+
+	if ( null === $post ) {
+		global $post;
+	} else {
+		$post = get_post( $post );
+	}
+
+	return $post && gutenberg_content_has_block( $block_name, $post->post_content );
+}
+
+/**
+ * Determine whether a content string contains a specific block. This test
+ * optimizes for performance rather than strict accuracy, detecting the
+ * block type but not validating its structure. For strict accuracy,
+ * you should use the block parser on post content.
+ *
+ * @since 3.4
+ * @see gutenberg_parse_blocks()
+ *
+ * @param string $block_name Full Block name to look for.
+ * @param string $content Content to test. Fallback on the $post global's content in case it's missing.
+ * @return bool Whether the content contain the specified block.
+ */
+function gutenberg_content_has_block( $block_name, $content = null ) {
+	global $post;
+
+	if ( null === $content && isset( $post->post_content ) ) {
+		$content = $post->post_content;
+	}
+
+	if ( ! gutenberg_content_has_blocks( $content ) ) {
+		return false;
+	}
+
+	return false !== strpos( $content, '<!-- wp:' . $block_name . ' ' );
+}

phpunit/class-block-type-test.php

@@ -9,6 +9,50 @@
  * Tests for WP_Block_Type
  */
 class Block_Type_Test extends WP_UnitTestCase {
+	function setUp() {
+		parent::setUp();
+	}
+
+	/**
+	 * Editor user ID.
+	 *
+	 * @var int
+	 */
+	protected static $editor_user_id;
+
+	/**
+	 * ID for a post containing blocks.
+	 *
+	 * @var int
+	 */
+	protected static $post_with_blocks;
+
+	/**
+	 * ID for a post without blocks.
+	 *
+	 * @var int
+	 */
+	protected static $post_without_blocks;
+
+	/**
+	 * Set up before class.
+	 */
+	public static function wpSetUpBeforeClass() {
+		self::$editor_user_id = self::factory()->user->create( array(
+			'role' => 'editor',
+		) );
+
+		self::$post_with_blocks = self::factory()->post->create( array(
+			'post_title'   => 'Example',
+			'post_content' => "<!-- wp:core/text {\"dropCap\":true} -->\n<p class=\"has-drop-cap\">Tester</p>\n<!-- /wp:core/text -->",
+		) );
+
+		self::$post_without_blocks = self::factory()->post->create( array(
+			'post_title'   => 'Example',
+			'post_content' => 'Tester',
+		) );
+	}
+
 	function test_set_props() {
 		$name = 'core/dummy';
 		$args = array(
@@ -112,6 +156,80 @@ function test_prepare_attributes() {
 		), $prepared_attributes );
 	}
 
+	function test_has_block_with_mixed_content() {
+		$mixed_post_content = 'before' .
+			'<!-- wp:core/dummy --><!-- /wp:core/dummy -->' .
+			'<!-- wp:core/dummy_atts {"value":"b1"} --><!-- /wp:core/dummy_atts -->' .
+			'<!-- wp:core/dummy-child -->
+			<p>testing the test</p>
+			<!-- /wp:core/dummy-child -->' .
+			'between' .
+			'<!-- wp:core/self-close-dummy /-->' .
+			'<!-- wp:custom/dummy {"value":"b2"} /-->' .
+			'after';
+
+		$this->assertTrue( gutenberg_content_has_block( 'core/dummy', $mixed_post_content ) );
+
+		$this->assertTrue( gutenberg_content_has_block( 'core/dummy_atts', $mixed_post_content ) );
+
+		$this->assertTrue( gutenberg_content_has_block( 'core/dummy-child', $mixed_post_content ) );
+
+		$this->assertTrue( gutenberg_content_has_block( 'core/self-close-dummy', $mixed_post_content ) );
+
+		$this->assertTrue( gutenberg_content_has_block( 'custom/dummy', $mixed_post_content ) );
+
+		// checking for a partial block name should fail.
+		$this->assertFalse( gutenberg_content_has_block( 'core/dumm', $mixed_post_content ) );
+
+		// checking for a wrong namespace should fail.
+		$this->assertFalse( gutenberg_content_has_block( 'custom/dummy_atts', $mixed_post_content ) );
+
+		// checking for namespace only should not work. Or maybe ... ?
+		$this->assertFalse( gutenberg_content_has_block( 'core', $mixed_post_content ) );
+	}
+
+	function test_has_block_with_invalid_content() {
+		// some content with invalid HMTL comments and a single valid block.
+		$invalid_content = 'before' .
+			'<!- - wp:core/weird-space --><!-- /wp:core/weird-space -->' .
+			'<!--wp:core/untrimmed-left --><!-- /wp:core/untrimmed -->' .
+			'<!-- wp:core/dummy --><!-- /wp:core/dummy -->' .
+			'<!-- wp:core/untrimmed-right--><!-- /wp:core/untrimmed2 -->' .
+			'after';
+
+		$this->assertFalse( gutenberg_post_has_block( 'core/text', self::$post_without_blocks ) );
+
+		$this->assertFalse( gutenberg_content_has_block( 'core/weird-space', $invalid_content ) );
+
+		$this->assertFalse( gutenberg_content_has_block( 'core/untrimmed-left', $invalid_content ) );
+
+		$this->assertFalse( gutenberg_content_has_block( 'core/untrimmed-right', $invalid_content ) );
+
+		$this->assertTrue( gutenberg_content_has_block( 'core/dummy', $invalid_content ) );
+	}
+
+	function test_post_has_block() {
+		$static_content = "<!-- wp:core/text {\"dropCap\":true} -->\n<p class=\"has-drop-cap\">Tester</p>\n<!-- /wp:core/text -->";
+
+		$this->assertTrue( gutenberg_post_has_block( 'core/text', self::$post_with_blocks ) );
+		// should fail for a non-existent block `custom/dummy`.
+		$this->assertFalse( gutenberg_post_has_block( 'custom/dummy', self::$post_with_blocks ) );
+
+		$this->assertTrue( gutenberg_content_has_block( 'core/text', $static_content ) );
+		$this->assertFalse( gutenberg_content_has_block( 'custom/dummy', $static_content ) );
+
+		// this functions should not work without the second param until the $post global is set.
+		$this->assertFalse( gutenberg_content_has_block( 'core/text' ) );
+		$this->assertFalse( gutenberg_post_has_block( 'core/text' ) );
+
+		global $post;
+		$post = get_post( self::$post_with_blocks );
+
+		// check if the function correctly detects content from the $post global.
+		$this->assertTrue( gutenberg_content_has_block( 'core/text' ) );
+		$this->assertTrue( gutenberg_post_has_block( 'core/text' ) );
+	}
+
 	function render_dummy_block( $attributes ) {
 		return json_encode( $attributes );
 	}