WP_HTML_Open_Elements::walk_up( WP_HTML_Token|null $above_this_node = null )

Steps through the stack of open elements, starting with the bottom element (added last) and walking upwards to the one added first.

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().

Parameters

$above_this_nodeWP_HTML_Token|nulloptional: Start traversing above this node, if provided and if the node exists.
Default:null

Source

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;
	}
}

View all references View on Trac View on GitHub

Used by	Description
WP_HTML_Open_Elements::clear_to_table_context()`wp-includes/html-api/class-wp-html-open-elements.php`	Clear the stack back to a table context.
WP_HTML_Open_Elements::clear_to_table_body_context()`wp-includes/html-api/class-wp-html-open-elements.php`	Clear the stack back to a table body context.
WP_HTML_Open_Elements::clear_to_table_row_context()`wp-includes/html-api/class-wp-html-open-elements.php`	Clear the stack back to a table row context.
WP_HTML_Open_Elements::contains()`wp-includes/html-api/class-wp-html-open-elements.php`	Reports if a node of a given name is in the stack of open elements.
WP_HTML_Open_Elements::has_element_in_select_scope()`wp-includes/html-api/class-wp-html-open-elements.php`	Returns whether a particular element is in select scope.
WP_HTML_Open_Elements::pop_until()`wp-includes/html-api/class-wp-html-open-elements.php`	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()`wp-includes/html-api/class-wp-html-open-elements.php`	Removes a specific node from the stack of open elements.
WP_HTML_Open_Elements::has_element_in_specific_scope()`wp-includes/html-api/class-wp-html-open-elements.php`	Returns whether an element is in a specific scope.
WP_HTML_Open_Elements::contains_node()`wp-includes/html-api/class-wp-html-open-elements.php`	Reports if a specific node is in the stack of open elements.

Show 4 more Show less

Changelog

Version	Description
6.5.0	Accepts $above_this_node to start traversal above a given node, if it exists.
6.4.0	Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.