函数文档

walk_category_dropdown_tree()

💡 云策文档标注

概述

walk_category_dropdown_tree() 函数用于生成分类列表的 HTML 下拉菜单(select)内容。它基于 Walker 类实现,通过 Walker_CategoryDropdown 或自定义 Walker 来遍历和输出层级结构。

关键要点

  • 函数返回字符串形式的 HTML 下拉菜单内容,适用于分类列表。
  • 参数 $args 为混合类型,包含元素数组、最大层级深度和可选额外参数。
  • 内部使用 Walker 类进行遍历,默认使用 Walker_CategoryDropdown,但可通过参数自定义 Walker。
  • 与 wp_dropdown_categories() 函数关联,用于显示或检索分类的 HTML 下拉列表。
  • 自 WordPress 5.3.0 起,函数签名正式添加了 ...$args 参数。

代码示例

function walk_category_dropdown_tree( ...$args ) {
    // The user's options are the third parameter.
    if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
        $walker = new Walker_CategoryDropdown();
    } else {
        /**
         * @var Walker $walker
         */
        $walker = $args[2]['walker'];
    }
    return $walker->walk( ...$args );
}

📄 原文内容

Retrieves HTML dropdown (select) content for category list.

Description

See also

Parameters

$argsmixedrequired
Elements array, maximum hierarchical depth and optional additional arguments.

Return

string

Source

function walk_category_dropdown_tree( ...$args ) {
	// The user's options are the third parameter.
	if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) {
		$walker = new Walker_CategoryDropdown();
	} else {
		/**
		 * @var Walker $walker
		 */
		$walker = $args[2]['walker'];
	}
	return $walker->walk( ...$args );
}

Changelog

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