wppaste
WordPress

WP_Block_Processor::opens_block( string[] $block_type ): bool

Since
6.9.0
Source
wp-includes/class-wp-block-processor.php:1581
Indicates if the matched delimiter is an opening or void delimiter of the given type, if a type is provided, otherwise if it opens any block or implicit freeform HTML content.

Description

This is a helper method to ease handling of code inspecting where blocks start, and for checking if the blocks are of a given type. The function is variadic to allow for checking if the delimiter opens one of many possible block types.

To advance to the start of a block self::next_block().

Example:

$processor = new WP_Block_Processor( $html );
while ( $processor->next_delimiter() ) {
 if ( $processor->opens_block( 'core/code', 'syntaxhighlighter/code' ) ) {
 echo "Found code!";
 continue;
 }

 if ( $processor->opens_block( 'core/image' ) ) {
 echo "Found an image!";
 continue;
 }

 if ( $processor->opens_block() ) {
 echo "Found a new block!";
 }
}

Compatibility

WordPress
since 6.9.0
PHP
7.4–8.6-dev
  • 6.7.10
  • 6.8.11
  • 6.9.10
  • 7.0.7
  • 7.1.3

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

Parameters

$block_typestring[]
Is the matched block type one of these? If none are provided, will not test block type.

Return value

bool
Whether the matched block delimiter opens a block, and whether it opens a block of one of the given block types, if provided.

Performance profile

How much work a call to WP_Block_Processor::opens_block() 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 what you pass in.

Instructions
10–27

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

What one call costs · 4 distinct outcomes

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

WhenInstructionsCalls it makes
always10–20none
always13–23->is_html()
!$block_type && ->is_block_type()20–24->is_block_type()
->is_html() && !$block_type && ->is_block_type()23–27->is_html(), ->is_block_type()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 32 instructions, 10–27 executed per call, 8 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source code

View on Trac View on GitHub 

	public function opens_block( string ...$block_type ): bool {		// HTML spans only open implicit freeform content at the top level.		if ( self::HTML_SPAN === $this->state && 1 !== count( $this->open_blocks_at ) ) {			return false;		} 		/*		 * Because HTML spans are discovered after the next delimiter is found,		 * the delimiter type when visiting HTML spans refers to the type of the		 * following delimiter. Therefore the HTML case is handled by checking		 * the state and depth of the stack of open block.		 */		if ( self::CLOSER === $this->type && ! $this->is_html() ) {			return false;		} 		if ( count( $block_type ) === 0 ) {			return true;		} 		foreach ( $block_type as $block ) {			if ( $this->is_block_type( $block ) ) {				return true;			}		} 		return false;	}

Changelog

Introduced in 6.9.0. Unchanged from 6.9.10 through 7.1.3.

  1. 6.9.10
  2. 7.0.7
  3. 7.1.3

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

About this page

Parsed data
Generated from the wordpress-develop 6.9.10 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.