WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

Walker::start_el()

Walker::start_el( string $output, object $data_object, int $depth, array $args = array(), int $current_object_id )

In this article

Back to top

Starts the element output.

Description

The $args parameter holds additional values that may be used with the child class methods. Also includes the element output.

Parameters

$outputstringrequired
Used to append additional content (passed by reference).
$data_objectobjectrequired
The data object.
$depthintrequired
Depth of the item.
$argsarrayoptional
An array of additional arguments.

Default:array()

$current_object_idintoptional
ID of the current item. Default 0.

More Information

This method is abstract and should be explicitly defined in the child class, as needed. Also note that $output is passed by reference, so any changes made to the variable within the following methods are automatically handled (no return, echo, or print needed).

“Start Element”. Generally, this method is used to add the opening HTML tag for a single tree item (such as <li>, <span>, or <a>) to $output.

Source

public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {}

View all references View on Trac View on GitHub

Used byDescription
Walker::display_element()wp-includes/class-wp-walker.php

Traverses elements to create list from elements.

Changelog

VersionDescription
5.9.0Renamed $object (a PHP reserved keyword) to $data_object for PHP 8 named parameter support.
2.1.0Introduced.

User Contributed Notes

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