wppaste
WordPress

WP_HTML_Processor::get_tag(): string|null

Since
6.4.0
Source
wp-includes/html-api/class-wp-html-processor.php:5168
Returns the uppercase name of the matched tag.

Description

The semantic rules for HTML specify that certain tags be reprocessed with a different tag name. Because of this, the tag name presented by the HTML Processor may differ from the one reported by the HTML Tag Processor, which doesn't apply these semantic rules.

Example:

$processor = new WP_HTML_Tag_Processor( '<div class="test">Test</div>' );
$processor->next_tag() === true;
$processor->get_tag() === 'DIV';

$processor->next_tag() === false;
$processor->get_tag() === null;

Compatibility

WordPress
since 6.4.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.

Return value

string|null
Name of currently matched tag in input HTML, or null if none found.

Performance profile

How much work a call to WP_HTML_Processor::get_tag() 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
4–23

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
7

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

What one call costs · 5 distinct outcomes

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

WhenInstructionsCalls it makes
always4none
->is_virtual()11->is_virtual()
!->is_virtual() && $tag_name !== "IMAGE"14->is_virtual(), ::get_tag()
!->is_virtual() && $tag_name === "IMAGE"18->is_virtual(), ::get_tag(), ->get_namespace()
!->is_virtual() && $tag_name === "IMAGE"22–23->is_virtual(), ::get_tag(), ->get_namespace(), ->get_token_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: 30 instructions, 4–23 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.

Uses · 4

Used by · 7

Source code

View on Trac View on GitHub 

	public function get_tag(): ?string {		if ( null !== $this->last_error ) {			return null;		} 		if ( $this->is_virtual() ) {			return $this->current_element->token->node_name;		} 		$tag_name = parent::get_tag(); 		/*		 * > A start tag whose tag name is "image"		 * > Change the token's tag name to "img" and reprocess it. (Don't ask.)		 *		 * This only applies to tags; a processing instruction target or a		 * comment which looks like a processing instruction may also report		 * a tag name and must not be rewritten.		 */		return ( 'IMAGE' === $tag_name && 'html' === $this->get_namespace() && '#tag' === $this->get_token_type() )			? 'IMG'			: $tag_name;	}

Changelog

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