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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray|stringoptional

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

• $depthintdefault: 0

  Maximum depth.

• $child_ofintdefault: 0

  Page ID to retrieve child pages of.

• $selectedint|stringdefault: 0

  Value of the option that should be selected.

• $echobool|intdefault: 1

  Whether to echo or return the generated markup. Accepts 0, 1, or their bool equivalents.

• $namestringdefault: 'page_id'

  Value for the 'name' attribute of the select element.

• $idstring

  Value for the 'id' attribute of the select element.

• $classstringdefault: none. Defaults to the value of $name

  Value for the 'class' attribute of the select element.

• $show_option_nonestringdefault: empty (does not display)

  Text to display for showing no pages.

• $show_option_no_changestringdefault: empty (does not display)

  Text to display for "no change" option.

• $option_none_valuestringdefault: empty

  Value to use when no page is selected.

• $value_fieldstringdefault: 'ID'

  Post field used to populate the 'value' attribute of the option elements. Accepts any valid post field.

Return value

string

HTML dropdown list of pages.

Performance profile

How much work a call to wp_dropdown_pages() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_pages().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

26–86

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 86.

Plugin surface

1 hook

Third-party callbacks on 'wp_dropdown_pages' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_pages()called directly
• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_dropdown_pages() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_dropdown_pages() runs, in this order:

1. 1
   apply_filters( wp_dropdown_pages )filterline 1250 (+52 into the body)

   Filters the HTML output of a list of pages as a dropdown.

Uses · 5

• wp_parse_args()Merges user defined arguments into defaults array.
• get_pages()Retrieves an array of pages (or hierarchical post type items).
• esc_attr()Escaping for HTML attributes.
• walk_page_dropdown_tree()Retrieves HTML dropdown (select) content for page list.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• WP_Customize_Control::render_content()Renders the control's content.
• WP_Posts_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
• page_attributes_meta_box()Displays page attributes form fields.

Source code

View on Trac ↗View on GitHub ↗

1198function wp_dropdown_pages( $args = '' ) {1199	$defaults = array(1200		'depth'                 => 0,1201		'child_of'              => 0,1202		'selected'              => 0,1203		'echo'                  => 1,1204		'name'                  => 'page_id',1205		'id'                    => '',1206		'class'                 => '',1207		'show_option_none'      => '',1208		'show_option_no_change' => '',1209		'option_none_value'     => '',1210		'value_field'           => 'ID',1211	);1212 1213	$parsed_args = wp_parse_args( $args, $defaults );1214 1215	$pages  = get_pages( $parsed_args );1216	$output = '';1217	// Back-compat with old system where both id and name were based on $name argument.1218	if ( empty( $parsed_args['id'] ) ) {1219		$parsed_args['id'] = $parsed_args['name'];1220	}1221 1222	if ( ! empty( $pages ) ) {1223		$class = '';1224		if ( ! empty( $parsed_args['class'] ) ) {1225			$class = " class='" . esc_attr( $parsed_args['class'] ) . "'";1226		}1227 1228		$output = "<select name='" . esc_attr( $parsed_args['name'] ) . "'" . $class . " id='" . esc_attr( $parsed_args['id'] ) . "'>\n";1229		if ( $parsed_args['show_option_no_change'] ) {1230			$output .= "\t<option value=\"-1\">" . $parsed_args['show_option_no_change'] . "</option>\n";1231		}1232		if ( $parsed_args['show_option_none'] ) {1233			$output .= "\t<option value=\"" . esc_attr( $parsed_args['option_none_value'] ) . '">' . $parsed_args['show_option_none'] . "</option>\n";1234		}1235		$output .= walk_page_dropdown_tree( $pages, $parsed_args['depth'], $parsed_args );1236		$output .= "</select>\n";1237	}1238 1239	/**1240	 * Filters the HTML output of a list of pages as a dropdown.1241	 *1242	 * @since 2.1.01243	 * @since 4.4.0 `$parsed_args` and `$pages` added as arguments.1244	 *1245	 * @param string    $output      HTML output for dropdown list of pages.1246	 * @param array     $parsed_args The parsed arguments array. See wp_dropdown_pages()1247	 *                               for information on accepted arguments.1248	 * @param WP_Post[] $pages       Array of the page objects.1249	 */1250	$html = apply_filters( 'wp_dropdown_pages', $output, $parsed_args, $pages );1251 1252	if ( $parsed_args['echo'] ) {1253		echo $html;1254	}1255 1256	return $html;1257}

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/post-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.