Block Processor: Fix is_block_type() for inner HTML

Previously, the WP_Block_Processor class was making a mistake in
mis-reporting whether a token matches a block type when #innerHTML spans
are involved.

This patch fixes the logic, which was originally written before a
distinction between inner HTML and top-level freeform content was built.

Developed in #10701
Discussed in https://core.trac.wordpress.org/ticket/64485

Fixes #64485.


git-svn-id: https://develop.svn.wordpress.org/trunk@61452 602fd350-edb4-49c9-b593-d223f7449a82

Author: dmsnell

src/wp-includes/class-wp-block-processor.php

@@ -1440,12 +1440,17 @@ public function is_block_type( string $block_type ): bool {
 			return true;
 		}
 
-		// This is a core/freeform text block, it’s special.
-		if ( $this->is_html() && 0 === ( $this->open_blocks_length[0] ?? null ) ) {
-			return (
-				'core/freeform' === $block_type ||
-				'freeform' === $block_type
-			);
+		if ( $this->is_html() ) {
+			// This is a core/freeform text block, it’s special.
+			if ( 0 === ( $this->open_blocks_length[0] ?? null ) ) {
+				return (
+					'core/freeform' === $block_type ||
+					'freeform' === $block_type
+				);
+			}
+
+			// Otherwise this is innerHTML and not a block.
+			return false;
 		}
 
 		return $this->are_equal_block_types( $this->source_text, $this->namespace_at, $this->name_at - $this->namespace_at + $this->name_length, $block_type, 0, strlen( $block_type ) );

tests/phpunit/tests/block-processor/wpBlockProcessor.php

@@ -747,6 +747,46 @@ public function test_reports_if_block_is_of_type( $html, $block_type ) {
 		}
 	}
 
+	/**
+	 * Verifies that innerHTML only matches as a block type when checking with the wildcard '*'.
+	 *
+	 * @ticket 64485
+	 *
+	 * @covers ::is_block_type()
+	 */
+	public function test_inner_html_is_only_a_block_type_match_with_the_wildcard() {
+		$processor = new WP_Block_Processor( '0<!-- wp:b1 -->1<!-- wp:b2 -->' );
+
+		$processor->next_token();
+		$this->assertTrue(
+			$processor->is_block_type( 'freeform' ),
+			'Failed to detect top-level freeform HTML as freeform block: check test setup.'
+		);
+
+		$processor->next_token();
+		$this->assertTrue(
+			$processor->is_block_type( 'b1' ),
+			'Failed to detect opening delimiter as b1 block type: check test setup.'
+		);
+
+		$processor->next_token();
+		$this->assertFalse(
+			(
+				$processor->is_block_type( 'freeform' ) ||
+				$processor->is_block_type( 'b1' ) ||
+				$processor->is_block_type( 'core/freeform' ) ||
+				$processor->is_block_type( 'core/b1' ) ||
+				$processor->is_block_type( '' )
+			),
+			'Failed to reject innerHTML as a matched block type.'
+		);
+
+		$this->assertTrue(
+			$processor->is_block_type( '*' ),
+			'Failed to accept innerHTML as a wildcard block-type match.'
+		);
+	}
+
 	/**
 	 * Verifies that the processor indicates if the currently-matched delimiter
 	 * opens a block of a given block type. This is true for openers and void delimiters.
@@ -1211,6 +1251,65 @@ public static function data_content_and_delimiter_spans() {
 		);
 	}
 
+	/**
+	 * Verifies that next_block( $block_type ) scans directly to the appropriate tokens.
+	 *
+	 * @ticket 64485
+	 *
+	 * @dataProvider data_markup_with_block_of_given_type
+	 *
+	 * @param string $html       Contains block markup, including the tested block type.
+	 * @param string $block_type Jump to this block type.
+	 */
+	public function test_scans_directly_to_requested_block_type( string $html, string $block_type ) {
+		$processor = new WP_Block_Processor( $html );
+
+		$this->assertTrue(
+			$processor->next_block( $block_type ),
+			'Failed to find block of requested type.'
+		);
+
+		$full_block_type = WP_Block_Processor::normalize_block_type( $block_type );
+
+		if ( 'core/freeform' === $full_block_type ) {
+			$this->assertTrue(
+				$processor->is_html(),
+				'Failed to match on HTML token when looking for freeform content.'
+			);
+
+			$this->assertSame(
+				0,
+				$processor->get_depth(),
+				'Failed to scan to top-level freeform content when searching for freeform.'
+			);
+		} else {
+			$this->assertFalse(
+				$processor->is_html(),
+				'Matched on HTML token when looking for block delimiter.'
+			);
+		}
+
+		$this->assertSame(
+			$full_block_type,
+			$processor->get_printable_block_type(),
+			'Scanned to token of wrong block type.'
+		);
+	}
+
+	/**
+	 * Data provider.
+	 *
+	 * @return array[]
+	 */
+	public static function data_markup_with_block_of_given_type() {
+		return array(
+			'At start of HTML'    => array( '<!-- wp:target -->', 'target' ),
+			'After freeform text' => array( 'prefix<!-- wp:target -->', 'target' ),
+			'After outer block'   => array( 'prefix<!-- wp:group --><!-- wp:target -->', 'target' ),
+			'After innerHTML'     => array( 'prefix<!-- wp:group -->inner<!-- wp:target -->', 'target' ),
+		);
+	}
+
 	//
 	// Test helpers.
 	//