WordPress下拉列表输出页面标签：wp_dropdown_pages

WordPress模板标签wp_dropdown_pages用于输出页面列表，与其他输出页面列表的函数比较，wp_dropdown_pages()函数不是以<li>列表输出，而是<select>下拉列表。

wp_dropdown_pages( array|string $args = '' )

函数参数

$args

数组或字符串值

wp_dropdown_pages()函数$args参数默认的值如下：

$args = array(
	'depth'                 => 0,
	'child_of'              => 0,
	'selected'              => 0,
	'echo'                  => 1,
	'name'                  => 'page_id',
	'id'                    => null,
	'class'                 => null,
	'show_option_none'      => null,
	'show_option_no_change' => null,
	'option_none_value'     => null,
);

wp_dropdown_pages()函数$args参数可用的值如下：

depth

整数型，默认值：0

  • 0：输出所有的页面和子页面，按层级的方式输出；
  • 1：只输出顶级页面，不包含任何子页面；
  • n：根据n的具体数字来显示相应等级的页面；
  • -1：输出所有的页面和子页面，不以层级的方式输出；

child_of

整数型，默认值：0

指定一个页面ID，将输出该页面的子页面，不包含该页面。

selected

整数型，默认值：0

指定一个页面ID，这个页面的<option>标签将添加selected属性，也就是选中状态。

echo

布尔值，默认值：1

是否输出结果，如果为0，只返回结果而不输出。

name

字符串值，默认值：page_id

<select>标签name属性的值

id

字符串值，默认值：与name的值相同

<select>标签id属性的值

class

字符串值，默认为空

<select>标签class属性的值

show_option_none

字符串值，默认为空

通常情况下，下拉列表有一个名为“请选择”的空<option>，该值指定这个空<option>的文本。

option_none_value

字符串值，默认为空

为show_option_none添加的<option>指定value值

show_option_no_change

字符串值，默认为空

添加一个value为-1的选项，show_option_no_change的值为这个<option>的文本。

exclude

字符串值，默认为空

要排除的页面ID，多个ID用逗号分隔。

exclude_tree

字符串值，默认为空

要排除的页面ID，多个ID用逗号分隔，连同子页面一起排除。

函数使用示例

只显示顶级页面，设置ID为15的页面默认被选中，并添加了一个“请选择”的选项

<?php
	$args = array(
		'depth' => 1,
		'selected' => 15,
		'show_option_none' => '请选择'
	);
	wp_dropdown_pages($args);
?>

下面的代码输出一样的结果：

<?php wp_dropdown_pages('depth=1&selected=15&show_option_none=请选择'); ?>

扩展阅读

wp_dropdown_pages()函数位于：wp-includes/post-template.php

相关函数：

Typora