Walker_PageDropdown::start_el() – Method

Starts the element output.

Description

Parameters

$outputstringrequired

Used to append additional content. Passed by reference.

$data_objectWP_Postrequired

Page data object.

$depthintoptional

Depth of page in reference to parent pages.
Used for padding. Default 0.

$argsarrayoptional

Uses 'selected' argument for selected page to set selected HTML attribute for option element. Uses 'value_field' argument to fill "value" attribute.
See wp_dropdown_pages() .

More Arguments from wp_dropdown_pages( … $args )

Array or string of arguments to retrieve pages.

child_of int
Page ID to return child and grandchild pages of. Note: The value of $hierarchical has no bearing on whether $child_of returns hierarchical results. Default 0, or no restriction.
sort_order string
How to sort retrieved pages. Accepts 'ASC', 'DESC'. Default 'ASC'.
sort_column string
What columns to sort pages by, comma-separated. Accepts 'post_author', 'post_date', 'post_title', 'post_name', 'post_modified', 'menu_order', 'post_modified_gmt', 'post_parent', 'ID', 'rand', 'comment*count'.
'post*' can be omitted for any values that start with it.
Default 'post_title'.
hierarchical bool
Whether to return pages hierarchically. If false in conjunction with $child_of also being false, both arguments will be disregarded.
Default true.
exclude int[]
Array of page IDs to exclude.
include int[]
Array of page IDs to include. Cannot be used with $child_of, $parent, $exclude, $meta_key, $meta_value, or $hierarchical.
meta_key string
Only include pages with this meta key.
meta_value string
Only include pages with this meta value. Requires $meta_key.
authors string
A comma-separated list of author IDs.
parent int
Page ID to return direct children of. Default -1, or no restriction.
exclude_tree string|int[]
Comma-separated string or array of page IDs to exclude.
number int
The number of pages to return. Default 0, or all pages.
offset int
The number of pages to skip before returning. Requires $number.
Default 0.
post_type string
The post type to query. Default 'page'.
post_status string|array
A comma-separated list or array of post statuses to include.
Default 'publish'.

Default:array()

$current_object_idintoptional

ID of the current page. Default 0.

Source

public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {
	// Restores the more descriptive, specific name for use within this method.
	$page = $data_object;

	$pad = str_repeat( '&nbsp;', $depth * 3 );

	if ( ! isset( $args['value_field'] ) || ! isset( $page->{$args['value_field']} ) ) {
		$args['value_field'] = 'ID';
	}

	$output .= "\t<option class=\"level-$depth\" value=\"" . esc_attr( $page->{$args['value_field']} ) . '"';
	if ( $page->ID === (int) $args['selected'] ) {
		$output .= ' selected="selected"';
	}
	$output .= '>';

	$title = $page->post_title;
	if ( '' === $title ) {
		/* translators: %d: ID of a post. */
		$title = sprintf( __( '#%d (no title)' ), $page->ID );
	}

	/**
	 * Filters the page title when creating an HTML drop-down list of pages.
	 *
	 * @since 3.1.0
	 *
	 * @param string  $title Page title.
	 * @param WP_Post $page  Page data object.
	 */
	$title = apply_filters( 'list_pages', $title, $page );

	$output .= $pad . esc_html( $title );
	$output .= "</option>\n";
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘list_pages’, string $title, WP_Post $page ): Filters the page title when creating an HTML drop-down list of pages.

Uses	Description
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
esc_attr()`wp-includes/formatting.php`	Escaping for HTML attributes.
esc_html()`wp-includes/formatting.php`	Escaping for HTML blocks.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 2 more Show less

Changelog

Version	Description
5.9.0	Renamed `$page` to `$data_object` and `$id` to `$current_object_id` to match parent class for PHP 8 named parameter support.
2.1.0	Introduced.

User Contributed Notes

Skip to note 2 content

changwoo 4 years ago

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

<option selected=”selected”> might not work properly when ‘value_field’ parameter value is not ‘ID’,
because the line 66 says:

if ( $page->ID == $args['selected'] )

This line should be modified, like:

if ( $page->{$args['value_field']} == $args['selected'] )
- Simply put: if value_field argument is not ID, note that the selected argument must still be the selected page’s ID.
  
  crstauf 4 years ago
Log in to add feedback

Walker_PageDropdown::start_el( string $output, WP_Post $data_object, int $depth, array $args = array(), int $current_object_id )

In this article