WP_HTML_Processor::get_current_depth(): int
- Since
- 6.6.0
- Source
wp-includes/html-api/class-wp-html-processor.php:1231
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();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
int- Nesting-depth of current location in the document.
Performance profile
How much work a call to WP_HTML_Processor::get_current_depth() 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
- 3
- Plugin surface
- None
- Called by
- 0
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. The body compiles to 3.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
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_Processor::get_current_depth() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 3 | 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: 3 instructions, 3 executed per call, 0 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.
Source code
public function get_current_depth(): int { return count( $this->breadcrumbs ); }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.