wp_dropdown_pages() │ WP 2.1.0

Retrieve or display list of pages as a dropdown (select list).

Uses: get_pages()

Hooks from the function

wp_dropdown_pages

Return

String. HTML dropdown list of pages.

Usage

wp_dropdown_pages( $args );

$args(array|string)

Array or string of arguments to generate a page dropdown. See get_pages() for additional arguments.

Default: ''

depth(int)
Maximum depth.
child_of(int)
Page ID to retrieve child pages of.
selected(int|string)
Value of the option that should be selected.
echo(true|false|int)
Whether to echo or return the generated markup. Accepts 0, 1, or their bool equivalents.
Default: 1
name(string)
Value for the 'name' attribute of the select element.
Default: 'page_id'
id(string)
Value for the 'id' attribute of the select element.
class(string)
Value for the 'class' attribute of the select element. Defaults to the value of $name.
Default: none
show_option_none(string)
Text to display for showing no pages.
Default: empty (does not display)
show_option_no_change(string)
Text to display for "no change" option.
Default: empty (does not display)
option_none_value(string)
Value to use when no page is selected.
Default: ''
value_field(string)
Post field used to populate the 'value' attribute of the option elements. Accepts any valid post field.
Default: 'ID'

Examples

#1 Demo

<?php wp_dropdown_pages(); ?>

We get it:

<select name='page_id' id='page_id'>
	<option class="level-0" value="760">Page 1</option>
	<option class="level-0" value="280">Page 2</option>
	<option class="level-1" value="1544"> Subsidiary page 1</option>
	<option class="level-1" value="3484"> Subsidiary page 2</option>
	<option class="level-1" value="3644"> Subsidiary page 3</option>
	<option class="level-0" value="4970">Page 3</option>
	<option class="level-0" value="7">Page 4</option>
</select>

#2 An example of a dropdown list of static pages with a submit button:

<li id="pages">

	<h2><?php _e('pages:'); ?></h2>

	<form action="<?php bloginfo('url'); ?>" method="get">
	<?php wp_dropdown_pages(); ?>
	<input type="submit" name="submit" value="view" />
	</form>

</li>

#3 Make dropdown list multiple select

This is useful when you want to make multiple select or using with select2.js kinda things.

add_filter( 'wp_dropdown_pages', 'wporg_domain_make_multiple_select_pages' );

function wporg_domain_make_multiple_select_pages( $output ) {
	return str_replace( '<select ', '<select multiple="multiple" ', $output );
}

Notes

See: get_pages()

Changelog

Since 2.1.0	Introduced.
Since 4.2.0	The `$value_field` argument was added.
Since 4.3.0	The `$class` argument was added.

`wp_dropdown_pages() wp dropdown pages` code ^{WP 6.1.1}

wp-includes/post-template.php

function wp_dropdown_pages( $args = '' ) {
	$defaults = array(
		'depth'                 => 0,
		'child_of'              => 0,
		'selected'              => 0,
		'echo'                  => 1,
		'name'                  => 'page_id',
		'id'                    => '',
		'class'                 => '',
		'show_option_none'      => '',
		'show_option_no_change' => '',
		'option_none_value'     => '',
		'value_field'           => 'ID',
	);

	$parsed_args = wp_parse_args( $args, $defaults );

	$pages  = get_pages( $parsed_args );
	$output = '';
	// Back-compat with old system where both id and name were based on $name argument.
	if ( empty( $parsed_args['id'] ) ) {
		$parsed_args['id'] = $parsed_args['name'];
	}

	if ( ! empty( $pages ) ) {
		$class = '';
		if ( ! empty( $parsed_args['class'] ) ) {
			$class = " class='" . esc_attr( $parsed_args['class'] ) . "'";
		}

		$output = "<select name='" . esc_attr( $parsed_args['name'] ) . "'" . $class . " id='" . esc_attr( $parsed_args['id'] ) . "'>\n";
		if ( $parsed_args['show_option_no_change'] ) {
			$output .= "\t<option value=\"-1\">" . $parsed_args['show_option_no_change'] . "</option>\n";
		}
		if ( $parsed_args['show_option_none'] ) {
			$output .= "\t<option value=\"" . esc_attr( $parsed_args['option_none_value'] ) . '">' . $parsed_args['show_option_none'] . "</option>\n";
		}
		$output .= walk_page_dropdown_tree( $pages, $parsed_args['depth'], $parsed_args );
		$output .= "</select>\n";
	}

	/**
	 * Filters the HTML output of a list of pages as a dropdown.
	 *
	 * @since 2.1.0
	 * @since 4.4.0 `$parsed_args` and `$pages` added as arguments.
	 *
	 * @param string    $output      HTML output for dropdown list of pages.
	 * @param array     $parsed_args The parsed arguments array. See wp_dropdown_pages()
	 *                               for information on accepted arguments.
	 * @param WP_Post[] $pages       Array of the page objects.
	 */
	$html = apply_filters( 'wp_dropdown_pages', $output, $parsed_args, $pages );

	if ( $parsed_args['echo'] ) {
		echo $html;
	}

	return $html;
}