wppaste
WordPress

WP_HTML_Open_Elements::current_node_is( string $identity ): bool

Since
6.7.0
Source
wp-includes/html-api/class-wp-html-open-elements.php:218
Indicates if the current node is of a given type or name.

Description

It's possible to pass either a node type or a node name to this function.
In the case there is no current element it will always return false.

Example:

// Is the current node a text node?
$stack->current_node_is( '#text' );

// Is the current node a DIV element?
$stack->current_node_is( 'DIV' );

// Is the current node any element/tag?
$stack->current_node_is( '#tag' );

Compatibility

WordPress
since 6.7.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$identitystring
Check if the current node has this name or type (depending on what is provided).

Return value

bool
Whether there is a current element that matches the given identity, whether a token name or type.

Performance profile

How much work a call to WP_HTML_Open_Elements::current_node_is() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
9–22

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always9–18end()
$current_node !== false && $current_node_name !== false && $identity === "#tag"20–22end(), ctype_upper()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 23 instructions, 9–22 executed per call, 5 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.

Source code

View on Trac View on GitHub 

	public function current_node_is( string $identity ): bool {		$current_node = end( $this->stack );		if ( false === $current_node ) {			return false;		} 		$current_node_name = $current_node->node_name; 		return (			$current_node_name === $identity ||			( '#doctype' === $identity && 'html' === $current_node_name ) ||			( '#tag' === $identity && ctype_upper( $current_node_name ) )		);	}

Changelog

Introduced in 6.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

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

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/html-api/class-wp-html-open-elements.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.