wppaste
WordPress

Walker_Comment::display_element( WP_Comment $element, array $children_elements, int $max_depth, int $depth, array $args, string $output )

Since
2.7.0
Source
wp-includes/class-walker-comment.php:131
Traverses elements to create list from elements.

Description

This function is designed to enhance Walker::display_element() to display children of higher nesting levels than selected inline on the highest depth level displayed. This prevents them being orphaned at the end of the comment list.

Example: max_depth = 2, with 5 levels of nested content.
1 1.1 1.1.1 1.1.1.1 1.1.1.1.1 1.1.2 1.1.2.1 2 2.2

Compatibility

WordPress
since 2.7.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

$elementWP_Comment
Comment data object.
$children_elementsarray
List of elements to continue traversing. Passed by reference.
$max_depthint
Max depth to traverse.
$depthint
Depth of the current element.
$argsarray
An array of arguments.
$outputstring
Used to append additional content. Passed by reference.

Performance profile

How much work a call to Walker_Comment::display_element() 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
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
8–29

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 39.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place 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 Walker_Comment::display_element() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always8none
always22–29::display_element()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 39 instructions, 8–29 executed per call, 5 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.

Uses · 2

Used by · 1

Source code

	public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {		if ( ! $element ) {			return;		} 		$id_field = $this->db_fields['id'];		$id       = $element->$id_field; 		parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output ); 		/*		 * If at the max depth, and the current element still has children, loop over those		 * and display them at this level. This is to prevent them being orphaned to the end		 * of the list.		 */		if ( $max_depth <= $depth + 1 && isset( $children_elements[ $id ] ) ) {			foreach ( $children_elements[ $id ] as $child ) {				$this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output );			} 			unset( $children_elements[ $id ] );		}	}

Changelog

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-walker-comment.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.