wp_dropdown_users()
Выводит на экран выпадающий список пользователей.
Хуки из функции
Возвращает
Строку
. Возвращает или выводит на экран HTML код выпадающего списка пользователей: <select>
.
Шаблон использования
wp_dropdown_users( array( 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '', 'orderby' => 'display_name', 'order' => 'ASC', 'include' => '', 'exclude' => '', 'multi' => false, 'show' => 'display_name', 'echo' => true, 'selected' => false, 'include_selected' => false, 'name' => 'user', 'id' => 'user', 'class' => '', 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'role' => '', 'role__in' => array(), 'role__not_in' => array(), 'capability' => '', 'capability__in' => array(), 'capability__not_in' => array(), ) );
Использование
<?php wp_dropdown_users( $args ); ?>
- $args(строка/массив)
- Массив аргументов, в соответствии с которыми будет сформирован список (см.ниже).
По умолчанию: параметры по умолчанию
Аргументы параметра $args
Кроме перечисленных ниже параметров, также можно передавать параметры функции get_users().
- show_option_all(строка)
- Текст для пункта списка "выбрать всех" (будет в начале списка).
По умолчанию: '' - show_option_none(строка)
- Текст для пункта списка "ни один пользователь" (будет в начале списка или вторым пунктом, если установлен параметр show_option_all).
По умолчанию: '' - orderby(строка)
Ключ по которому сортировать список. Может быть:
-
ID
- сортировать по ID пользователя (теоретически получается по порядку регистрации); -
user_nicename
- сортировать по имени; display_name
- сортировать по отображаемому имени - по умолчанию.
По умолчанию: 'display_name'
-
- order(строка)
Направление сортировки:
-
ASC
- по порядку - по умолчанию; DESC
- в обратном порядке.
По умолчанию: 'ASC'
-
- include(строка)
- ID пользователей, которых нужно показать в списке (указывать через запятую). Например,
include=4,5,12
выведет список из трех пользователей.
По умолчанию: '' - exclude(строка)
- ID пользователей, которых не нужно показывать в списке (указывать через запятую). Например,
include=4,5,12
выведет список из пользователей, кроме 3-х указанных.
По умолчанию: '' - multi(логический)
- Пропустить или нет аттрибут ID у элемента
- show(строка)
Использовать указанную колонку таблицы, в качестве отображаемых полей. Если элемент пустой, то будет показано поле user_login.
ID
- показывать ID в пунктахuser_login
- показывать логин имя в пунктахdisplay_name
- показывать отображаемое имя в пунктах. По умолчаниюdisplay_name_with_login
- отображаемое имя и логин. С версии 4.5.
По умолчанию: 'display_name'
- echo(логический)
- 1/true - показать на экране, 0/false - вернуть результат.
По умолчанию: 1 - selected(число)
- ID пользователя, которого заранее нужно выделить в списке (добавится selected='selected').
По умолчанию: '' - include_selected(логический)
- Всегда включать в список пользователей с ID указанном в параметре selected. (где это может понадобится не понял).
По умолчанию: false - name(строка)
- Значение атрибута name у тега
- class(строка)
- Значение атрибута class у тега
- id(строка)
- Значение атрибута id у тега
- blog_id(число)
- ID блога. Только для мультисайтов. По умолчанию id текущего блога.
По умолчанию: $GLOBALS['blog_id'] - who(строка)
Каких пользователей отображать. Может быть:
''
— показывать всех пользователей. (По умолчанию)'authors'
— пользователи которые могут публиковать посты (с ролями: author, editor, administrator).
По умолчанию: ''
- role(строка/массив)
- Название роли пользователей с которой нужно включить в результат. Можно указать несколько названий в массиве. Если указан массив, то пользователь должен иметь все указанные роли одновременно. C WP 4.7.
- role__in(массив)
- Массив названий ролей пользователей которые будут добавлены в результат. Пользователь будет добавлен в результат, если у него есть хоть одна из указанных ролей. C WP 4.7.
По умолчанию: array() - role__not_in(массив)
- Массив названий ролей пользователей, которых нужно исключить из результата. Пользователь не будет добавлен в результат, если у него есть хоть одна из указанных ролей. C WP 4.7.
По умолчанию: array()
Примеры
#1 Выведем на экран выпадающий список всех пользователей
Сделаем из него полноценную форму отправки данных (внутри тега <form> и с кнопкой submit):
<h2>Пользователи:</h2> <form action="<?php bloginfo('url'); ?>" method="get"> <?php wp_dropdown_users( array('name'=>'author') ); ?> <input type="submit" name="submit" value="view" /> </form>
#2 Выпадающий список авторов в таблице записей
Смотрите в отдельной заметке.
Список изменений
С версии 2.3.0 | Введена. |
С версии 4.5.0 | Added the 'display_name_with_login' value for 'show'. |
С версии 4.7.0 | Added the 'role', 'role__in', and 'role__not_in' parameters. |
С версии 5.9.0 | Added the 'capability', 'capability__in', and 'capability__not_in' parameters. Deprecated the 'who' parameter. |