WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru Авторские Темы для WordPress

wp_dropdown_pages() WP 2.1.0

Выводит выпадающий список постоянных страниц (список в теге <select> ).

Работает на основе: get_pages()
Хуки из функции
Возвращает

Строку.

Шаблон использования

$args = array(
	'depth'            => 0,
	'child_of'         => 0,
	'selected'         => 0,
	'echo'             => 1,
	'name'             => 'page_id',
	'show_option_none' => '',
	'exclude'          => '',
	'exclude_tree'     => '',
	'value_field'      => 'ID', // поле для значения value e тега option
);
wp_dropdown_pages( $args );

Использование

wp_dropdown_pages( $args );
$args(строка/массив)
Массив аргументов которые нужно изменить. Можно указать как строку запроса.
По умолчанию: массив аргументов по умолчанию

Аргументы параметра $args

depth(число)

Этот параметр контролирует глубину вложенных страниц (сколько вложенных страниц будут показаны). По умолчанию 0 - будут показаны все уровни дочерних страниц.

  • 0 - все уровни дочерних страниц будут показаны. По умолчанию;

  • -1 - родительские и дочерние страницы будут показаны общим списком (без отступов от левого края);

  • 1 - показать только постоянные страницы первого уровня;

  • 2 - 2, 3, 4, 5 ... эти значения указывают до какой глубины показывать страницы.
child_of(число)
Показать только дочерние страницы указанной. Указывать надо ID родительской станицы.
selected(число)
ID постоянной страницы, которую нужно выделить в списке (указать атрибут selected).
По умолчанию: нет
echo(логический)
Выводить на экран (1) или возвращать для обработки (0). По умолчанию выводит на экран.
По умолчанию: 1
name(строка)
Значение атрибута name у HTML тега <select>.
По умолчанию: 'page_id'
show_option_none(строка)
Позволяет установить выбор поля select на пустое значение. Текст пустого значения указывается в этом параметре.
По умолчанию: ''
exclude(строка/число)
ID постоянных страниц, которые нужно исключить из списка. Указывать через запятую.
По умолчанию: ''
exclude_tree(число/строка)
ID родительских страниц, дерево которых не нужно показывать (включая саму станицу). Т.е. если указать, например, 45, то в списке будет отсутствовать страница 45 и все её подстраницы.
По умолчанию: ''
value_field(строка)
Поле, значение которого будет использоваться для значения атрибута value e тега option. Может быть названием любого поля таблицы posts (ID, post_title, post_name).
По умолчанию: 'ID'

Другие параметры

Кроме вышеописанных, также можно использовать и параметры рассчитанные на функцию get_pages(). Однако, эти параметры не подтверждены для этой функции, поэтому могут не работать.
Список, отсутствующих здесь, параметров get_pages():

$args = array(
	'sort_order'   => 'ASC',
	'sort_column'  => 'post_title',
	'hierarchical' => 1,
	'include'      => '',
	'meta_key'     => '',
	'meta_value'   => '',
	'authors'      => ''
);

Примеры

#1 Демонстрация работы

<?php wp_dropdown_pages(); ?>

Получим:

<select name='page_id' id='page_id'>
	<option class="level-0" value="760">Страница 1</option>
	<option class="level-0" value="280">Страница 2</option>
	<option class="level-1" value="1544">   Дочерняя страница 1</option>
	<option class="level-1" value="3484">   Дочерняя страница 2</option>
	<option class="level-1" value="3644">   Дочерняя страница 3</option>
	<option class="level-0" value="4970">Страница 3</option>
	<option class="level-0" value="7">Страница 4</option>
</select>

#2 Пример выпадающего списка постоянных страниц с кнопкой сабмита:

<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>

Заметки

  • Смотрите: get_pages()

Список изменений

С версии 2.1.0 Введена.
С версии 4.2.0 The $value_field argument was added.
С версии 4.3.0 The $class argument was added.

Код wp_dropdown_pages() WP 5.7.2

<?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 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;
}

Из метки: Список (wp_list списки)

Еще из раздела: Страницы

6 комментов
    Войти