walk_category_tree() WordPress Function
The walk_category_tree() function is a recursive function used to list categories in a hierarchy. It accepts a callback function as an argument, which is used to list the categories. The callback function is called for each category in the hierarchy, and is passed the category object, the category's depth in the hierarchy, and the current walker object.
walk_category_tree( mixed $args ) #
Retrieves HTML list content for category list.
Description
See also
- Walker::walk(): for parameters and return description.
Parameters
- $args
(mixed)(Required)Elements array, maximum hierarchical depth and optional additional arguments.
Return
(string)
Source
File: wp-includes/category-template.php
function walk_category_tree( ...$args ) { // The user's options are the third parameter. if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) { $walker = new Walker_Category; } else { /** * @var Walker $walker */ $walker = $args[2]['walker']; } return $walker->walk( ...$args ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.3.0 | Formalized the existing ...$args parameter by adding it to the function signature. |
2.1.0 | Introduced. |