WP_HTML_Processor::get_current_depth() – Method

WP_HTML_Processor::get_current_depth(): int

Returns the nesting depth of the current location in the document.

Description

Example:

$processor = WP_HTML_Processor::create_fragment( '<div><p></p></div>' );
// The processor starts in the BODY context, meaning it has depth from the start: HTML > BODY.
2 === $processor->get_current_depth();

// Opening the DIV element increases the depth.
$processor->next_token();
3 === $processor->get_current_depth();

// Opening the P element increases the depth.
$processor->next_token();
4 === $processor->get_current_depth();

// The P element is closed during `next_token()` so the depth is decreased to reflect that.
$processor->next_token();
3 === $processor->get_current_depth();

Return

int Nesting-depth of current location in the document.

Source

* while processing HTML, rather than a token found in the HTML text itself.
*
* @since 6.6.0
*
* @return bool Whether the current token is virtual.

View all references View on Trac View on GitHub

Changelog

Version	Description
6.6.0	Introduced.

User Contributed Notes

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