WP_Block_Processor::next_token(): bool

Description

<!-- wp:paragraph {"dropCap": true} -->
<!-- wp:separator /-->
<!-- /wp:paragraph -->
<p>Normal HTML content</p>
Plaintext content too!

// Find span containing wrapping HTML element surrounding inner blocks.
$processor = new WP_Block_Processor( $html );
if ( ! $processor->next_block( 'gallery' ) ) {
 return null;
}

$containing_span = null;
while ( $processor->next_token() && $processor->is_html() ) {
 $containing_span = $processor->get_span();
}

Compatibility

Present in 3 of the 5 tracked releases, added in 6.9.0, and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

Whether a token was matched or the end of the document was reached without finding any.

Performance profile

How much work a call to WP_Block_Processor::next_token() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

3–205

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 466.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 11 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Block_Processor::next_token() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 2

• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• WP_Block_Processor::find_html_comment_end()Returns the byte-offset after the ending character of an HTML comment, assuming the proper starting byte offset.

Used by · 2

• WP_Block_Processor::extract_full_block_and_advance()Extracts a block object, and all inner content, starting at a matched opening block delimiter, or at a matched top-level HTML span as freeform HTML content.
• WP_Block_Processor::next_delimiter()Advance to the next block delimiter in a document, indicating if one was found.

Source code

View on Trac ↗View on GitHub ↗

736	public function next_token(): bool {737		if ( $this->last_error || self::COMPLETE === $this->state || self::INCOMPLETE_INPUT === $this->state ) {738			return false;739		}740 741		// Void tokens automatically pop off the stack of open blocks.742		if ( $this->was_void ) {743			array_pop( $this->open_blocks_at );744			array_pop( $this->open_blocks_length );745			$this->was_void = false;746		}747 748		$text = $this->source_text;749		$end  = strlen( $text );750 751		/*752		 * Because HTML spans are inferred after finding the next delimiter, it means that753		 * the parser must transition out of that HTML state and reuse the token boundaries754		 * it found after the HTML span. If those boundaries are before the end of the755		 * document it implies that a real delimiter was found; otherwise this must be the756		 * terminating HTML span and the parsing is complete.757		 */758		if ( self::HTML_SPAN === $this->state ) {759			if ( $this->matched_delimiter_at >= $end ) {760				$this->state = self::COMPLETE;761				return false;762			}763 764			switch ( $this->next_stack_op ) {765				case 'void':766					$this->was_void             = true;767					$this->open_blocks_at[]     = $this->namespace_at;768					$this->open_blocks_length[] = $this->name_at + $this->name_length - $this->namespace_at;769					break;770 771				case 'push':772					$this->open_blocks_at[]     = $this->namespace_at;773					$this->open_blocks_length[] = $this->name_at + $this->name_length - $this->namespace_at;774					break;775 776				case 'pop':777					array_pop( $this->open_blocks_at );778					array_pop( $this->open_blocks_length );779					break;780			}781 782			$this->next_stack_op = null;783			$this->state         = self::MATCHED;784			return true;785		}786 787		$this->state          = self::READY;788		$after_prev_delimiter = $this->matched_delimiter_at + $this->matched_delimiter_length;789		$at                   = $after_prev_delimiter;790 791		while ( $at < $end ) {792			/*793			 * Find the next possible start of a delimiter.794			 *795			 * This follows the behavior in the official block parser, which segments a post796			 * by the block comment delimiters. It is possible for an HTML attribute to contain797			 * what looks like a block comment delimiter but which is actually an HTML attribute798			 * value. In such a case, the parser here will break apart the HTML and create the799			 * block boundary inside the HTML attribute. In other words, the block parser800			 * isolates sections of HTML from each other, even if that leads to malformed markup.801			 *802			 * For a more robust parse, scan through the document with the HTML API and parse803			 * comments once they are matched to see if they are also block delimiters. In804			 * practice, this nuance has not caused any known problems since developing blocks.805			 *806			 * <⃨!⃨-⃨-⃨ /wp:core/paragraph {"dropCap":true} /-->807			 */808			$comment_opening_at = strpos( $text, '<!--', $at );809 810			/*811			 * Even if the start of a potential block delimiter is not found, the document812			 * might end in a prefix of such, and in that case there is incomplete input.813			 */814			if ( false === $comment_opening_at ) {815				if ( str_ends_with( $text, '<!-' ) ) {

Changelog

Introduced in 6.9.0. Unchanged from 6.9.7 through 7.1.0.

1. 6.9.7
2. 7.0.4
3. 7.1.0

Signature, return type and hooks compared across 3 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-block-processor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.