Walker
- Since
- 2.1.0
- Source
wp-includes/class-wp-walker.php:14
A class for displaying various tree-like structures.
Description
Extend the Walker class to use it, see examples below. Child classes do not need to implement all of the abstract methods in the class. The child only needs to implement the methods that are needed.
Compatibility
- WordPress
- since 2.1.0
- 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).
Properties · 4
$tree_typestringpublic- What the class handles.
$db_fieldsstring[]public- DB fields to use.
$max_pagesintpublic- Max number of pages walked by the paged walker.
$has_childrenboolpublic- Whether the current element has children or not.
Methods · 9
- start_lvl()Starts the list before the elements are added.
- end_lvl()Ends the list of after the elements are added.
- start_el()Starts the element output.
- end_el()Ends the element output, if needed.
- display_element()Traverses elements to create list from elements.
- walk()Displays array of elements hierarchically.
- paged_walk()Produces a page of nested elements.
- get_number_of_root_elements()Calculates the total number of root elements.
- unset_children()Unsets all the children for a given top level element.
Changelog
Introduced in 2.1.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/class-wp-walker.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.