函数文档

walk_page_dropdown_tree()

💡 云策文档标注

概述

walk_page_dropdown_tree() 函数用于生成页面列表的 HTML 下拉菜单(select)内容。它基于 Walker_PageDropdown 类,通过 walk() 方法处理参数并返回字符串形式的 HTML。

关键要点

  • 函数 walk_page_dropdown_tree() 返回页面列表的 HTML 下拉菜单内容。
  • 默认使用 Walker_PageDropdown 类作为 walker,但可通过参数自定义 walker。
  • 参数 $args 为混合类型,包含元素数组、最大层级深度和可选附加参数。
  • 函数内部调用 walker 的 walk() 方法来生成输出。
  • 自 WordPress 5.3.0 起,函数签名正式添加了 ...$args 参数。

代码示例

function walk_page_dropdown_tree( ...$args ) {
    if ( empty( $args[2]['walker'] ) ) { // The user's options are the third parameter.
        $walker = new Walker_PageDropdown();
    } else {
        /**
         * @var Walker $walker
         */
        $walker = $args[2]['walker'];
    }

    return $walker->walk( ...$args );
}

注意事项

  • 如果未在 $args[2] 中指定 walker,则默认使用 Walker_PageDropdown。
  • 函数返回字符串,可直接用于输出或进一步处理。
  • 相关函数包括 wp_dropdown_pages(),它调用此函数来显示下拉菜单。

📄 原文内容

Retrieves HTML dropdown (select) content for page list.

Description

See also

Parameters

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

Return

string

Source

function walk_page_dropdown_tree( ...$args ) {
	if ( empty( $args[2]['walker'] ) ) { // The user's options are the third parameter.
		$walker = new Walker_PageDropdown();
	} 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.