wp_dropdown_pages( array|string $args = '' ): string

Retrieves or displays a list of pages as a dropdown (select list).

Contents

Description

Top ↑

See also

Top ↑

Parameters

$args array|string Optional
Array or string of arguments to generate a page dropdown. See get_pages() for additional arguments.
  • depthint
    Maximum depth. Default 0.
  • child_ofint
    Page ID to retrieve child pages of. Default 0.
  • selectedint|string
    Value of the option that should be selected. Default 0.
  • echobool|int
    Whether to echo or return the generated markup. Accepts 0, 1, or their bool equivalents. Default 1.
  • namestring
    Value for the 'name' attribute of the select element.
    Default 'page_id'.
  • idstring
    Value for the 'id' attribute of the select element.
  • classstring
    Value for the 'class' attribute of the select element. Default: none.
    Defaults to the value of $name.
  • show_option_nonestring
    Text to display for showing no pages. Default empty (does not display).
  • show_option_no_changestring
    Text to display for "no change" option. Default empty (does not display).
  • option_none_valuestring
    Value to use when no page is selected.
  • value_fieldstring
    Post field used to populate the 'value' attribute of the option elements. Accepts any valid post field. Default 'ID'.

Default: ''

Top ↑

Return

string HTML dropdown list of pages.

Top ↑

Source

File: wp-includes/post-template.php. View all references 

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 drop down.
	 *
	 * @since 2.1.0
	 * @since 4.4.0 `$parsed_args` and `$pages` added as arguments.
	 *
	 * @param string    $output      HTML output for drop down 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;
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Uses

Uses
Uses Description
walk_page_dropdown_tree() wp-includes/post-template.php

Retrieves HTML dropdown (select) content for page list.
get_pages() wp-includes/post.php

Retrieve an array of pages (or hierarchical post type items).
esc_attr() wp-includes/formatting.php

Escaping for HTML attributes.
wp_parse_args() wp-includes/functions.php

Merges user defined arguments into defaults array.
apply_filters() wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Show 3 more uses Hide more uses

Top ↑

Changelog

Changelog
Version Description
4.3.0 The $class argument was added.
4.2.0 The $value_field argument was added.
2.1.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Dropdown with submit button
    Displays a hierarchical page dropdown list in HTML form 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>
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by ghoul —

    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 );
}
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by John Dorner —

    For this to work for custom post types, you must set 

    'hierarchical' => true

    in the custom post type’s settings when you register_post_type that you are getting the dropdown for.
    If you don’t want the custom post type to truly be hierarchical, ensure the 'supports' arg doesn’t include 'page-attributes'

  4. Skip to note 4 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by jonburnaby —

    In addition, $args can include ‘sort_column’ and other get_pages() parameters, as shown in the page_attributes_meta_box() source code:

        $dropdown_args = array(
            'post_type'        => $post->post_type,
            'exclude_tree'     => $post->ID,
            'selected'         => $post->post_parent,
            'name'             => 'parent_id',
            'show_option_none' => __('(no parent)'),
            'sort_column'      => 'menu_order, post_title',
            'echo'             => 0,
        );
    ...
    $pages = wp_dropdown_pages( $dropdown_args );

You must log in before being able to contribute a note or feedback.