WP_HTML_Processor::expects_closer( WP_HTML_Token|null $node = null ): bool|null

Description

Compatibility

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

Parameters

$nodeWP_HTML_Token|nulloptional

Node to examine, if provided.
Default is to examine current node.Default: null

Return value

bool|null

Whether to expect a closer for the currently-matched node, or null if not matched on any token.

Performance profile

How much work a call to WP_HTML_Processor::expects_closer() 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

7–41

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

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 · 16 distinct outcomes

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

Uses · 4

• WP_HTML_Processor::get_token_name()Returns the node name represented by the token.
• WP_HTML_Processor::get_namespace()Indicates the namespace of the current token, or "html" if there is none.
• WP_HTML_Processor::has_self_closing_flag()Indicates if the currently matched tag contains the self-closing flag.
• WP_HTML_Processor::is_void()Returns whether a given element is an HTML Void Element

Used by · 2

• WP_HTML_Processor::next_visitable_token()Ensures internal accounting is maintained for HTML semantic rules while the underlying Tag Processor class is seeking to a bookmark.
• WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.

Source code

View on Trac ↗View on GitHub ↗

978	public function expects_closer( ?WP_HTML_Token $node = null ): ?bool {979		$token_name = $node->node_name ?? $this->get_token_name();980 981		if ( ! isset( $token_name ) ) {982			return null;983		}984 985		$token_namespace        = $node->namespace ?? $this->get_namespace();986		$token_has_self_closing = $node->has_self_closing_flag ?? $this->has_self_closing_flag();987 988		return ! (989			// Comments, text nodes, and other atomic tokens.990			'#' === $token_name[0] ||991			// Doctype declarations.992			'html' === $token_name ||993			// Void elements.994			( 'html' === $token_namespace && self::is_void( $token_name ) ) ||995			// Special atomic elements.996			( 'html' === $token_namespace && in_array( $token_name, array( 'IFRAME', 'NOEMBED', 'NOFRAMES', 'SCRIPT', 'STYLE', 'TEXTAREA', 'TITLE', 'XMP' ), true ) ) ||997			// Self-closing elements in foreign content.998			( 'html' !== $token_namespace && $token_has_self_closing )999		);1000	}

Changelog

Introduced in 6.6.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-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.