Walker_PageDropdown::start_el() WordPress Method

The Walker_PageDropdown::start_el() method is used to start the output of a dropdown list of pages. This method is called by the Walker_PageDropdown::walk() method when it starts walking the tree of pages. The method outputs the opening tag for the page item and sets up the $page variable for use by the Walker_PageDropdown::end_el() method.

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

Starts the element output.


Description

Top ↑

See also


Top ↑

Parameters

$output

(string)(Required)Used to append additional content. Passed by reference.

$data_object

(WP_Post)(Required)Page data object.

$depth

(int)(Optional) Depth of page in reference to parent pages. Used for padding. Default 0.

$args

(array)(Optional) 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().

Default value: array()

$current_object_id

(int)(Optional) ID of the current page. Default 0.


Top ↑

Source

File: wp-includes/class-walker-page-dropdown.php

	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( ' ', $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 == $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";
	}


Top ↑

Changelog

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

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.