WP_HTML_Processor::get_token_name(): string|null
- Since
- 6.6.0
- Source
wp-includes/html-api/class-wp-html-processor.php:5233
Description
This matches the DOM API value nodeName. Some values are static, such as #text for a text node, while others are dynamically generated from the token itself.
Dynamic names:
- Uppercase tag name for tag matches.
htmlfor DOCTYPE declarations.
Note that if the Tag Processor is not matched on a token then this function will return null, either because it hasn't yet found a token or because it reached the end of the document without matching a token.
Compatibility
- WordPress
- since 6.6.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 the matched token.
Performance profile
How much work a call to WP_HTML_Processor::get_token_name() 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
- Scaling
- Constant
- Instructions
- 8–9
- Plugin surface
- None
- Called by
- 20
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 12.
Nothing here hands control to plugin code.
20 places in core call this, so the cost is paid more often than your own code shows.
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_Processor::get_token_name() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->is_virtual() | 8 | ->is_virtual(), ::get_token_name() |
->is_virtual() | 9 | ->is_virtual() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 11 | 7–9 | 1 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 12 | 8–9 | 1 | |
| 8.4 | 12 | 8–9 | 1 | |
| 8.3 | 12 | 8–9 | 1 | |
| 8.2 | 12 | 8–9 | 1 | |
| 8.1 | 12 | 8–9 | 1 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 13 | 8–10 | 1 |
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
- WP_HTML_Processor::is_virtual()Indicates if the currently-matched token is virtual, created by a stack operation while processing HTML, rather than a token found in the HTML text itself.
- WP_HTML_Tag_Processor::get_token_name()Returns the node name represented by the token.
Used by · 20
- WP_HTML_Processor::expects_closer()Indicates if the currently-matched node expects a closing token, or if it will self-close on the next step.
- WP_HTML_Processor::in_body_any_other_end_tag()Applies the "any other end tag" parsing instructions for the IN BODY insertion mode.
- WP_HTML_Processor::next_tag()Finds the next tag matching the $query.
- WP_HTML_Processor::step()Steps through the HTML document and stop at the next tag, if any.
- WP_HTML_Processor::step_after_after_body()Parses next element in the 'after after body' insertion mode.
- WP_HTML_Processor::step_after_after_frameset()Parses next element in the 'after after frameset' insertion mode.
- WP_HTML_Processor::step_after_body()Parses next element in the 'after body' insertion mode.
- WP_HTML_Processor::step_after_frameset()Parses next element in the 'after frameset' insertion mode.
- WP_HTML_Processor::step_after_head()Parses next element in the 'after head' insertion mode.
- WP_HTML_Processor::step_before_head()Parses next element in the 'before head' insertion mode.
- WP_HTML_Processor::step_before_html()Parses next element in the 'before html' insertion mode.
- WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.
Show all 20
- WP_HTML_Processor::step_in_column_group()Parses next element in the 'in column group' insertion mode.
- WP_HTML_Processor::step_in_foreign_content()Parses next element in the 'in foreign content' insertion mode.
- WP_HTML_Processor::step_in_frameset()Parses next element in the 'in frameset' insertion mode.
- WP_HTML_Processor::step_in_head()Parses next element in the 'in head' insertion mode.
- WP_HTML_Processor::step_in_head_noscript()Parses next element in the 'in head noscript' insertion mode.
- WP_HTML_Processor::step_in_table()Parses next element in the 'in table' insertion mode.
- WP_HTML_Processor::step_in_template()Parses next element in the 'in template' insertion mode.
- WP_HTML_Processor::step_initial()Parses next element in the 'initial' insertion mode.
Source code
public function get_token_name(): ?string { return $this->is_virtual() ? $this->current_element->token->node_name : parent::get_token_name(); }Changelog
Introduced in 6.6.0. Unchanged from 6.7.7 through 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.