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

Top ↑

See also


Top ↑

Parameters

$args

(mixed)(Required)Elements array, maximum hierarchical depth and optional additional arguments.


Top ↑

Return

(string)


Top ↑

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 );
}


Top ↑

Changelog

Changelog
VersionDescription
5.3.0Formalized the existing ...$args parameter by adding it to the function signature.
2.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.