WP_HTML_Open_Elements::walk_up( WP_HTML_Token|null $above_this_node = null )
- Since
- 6.4.0, 6.5.0
- Source
wp-includes/html-api/class-wp-html-open-elements.php:642
Description
This generator function is designed to be used inside a "foreach" loop.
Example:
$html = '<em><strong><a>We are here';
foreach ( $stack->walk_up() as $node ) {
echo "{$node->node_name} -> ";
}
> A -> STRONG -> EM ->To start with the first added element and walk towards the bottom, see WP_HTML_Open_Elements::walk_down().
Compatibility
- WordPress
- since 6.5.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
$above_this_nodeWP_HTML_Token|nulloptional- Start traversing above this node, if provided and if the node exists.Default:
null
Performance profile
How much work a call to WP_HTML_Open_Elements::walk_up() 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
- Scales with input
- Instructions
- 10
- Plugin surface
- None
- Called by
- 8
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5. The body compiles to 18.
Nothing here hands control to plugin code.
8 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Open_Elements::walk_up() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$i | 10 | none |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 10 executed per call, 2 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.
Used by · 8
- WP_HTML_Open_Elements::clear_to_table_body_context()Clear the stack back to a table body context.
- WP_HTML_Open_Elements::clear_to_table_context()Clear the stack back to a table context.
- WP_HTML_Open_Elements::clear_to_table_row_context()Clear the stack back to a table row context.
- WP_HTML_Open_Elements::contains()Reports if an HTML element of a given name is on the stack of open elements.
- WP_HTML_Open_Elements::contains_node()Reports if a specific node is in the stack of open elements.
- WP_HTML_Open_Elements::has_element_in_specific_scope()Returns whether an element is in a specific scope.
- WP_HTML_Open_Elements::pop_until()Pops nodes off of the stack of open elements until an HTML tag with the given name has been popped.
- WP_HTML_Open_Elements::remove_node()Removes a specific node from the stack of open elements.
Source code
public function walk_up( ?WP_HTML_Token $above_this_node = null ) { $has_found_node = null === $above_this_node; for ( $i = count( $this->stack ) - 1; $i >= 0; $i-- ) { $node = $this->stack[ $i ]; if ( ! $has_found_node ) { $has_found_node = $node === $above_this_node; continue; } yield $node; } }Changelog
Introduced in 6.4.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-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.