Функция wp_list_authors() в WordPress позволяет вывести список авторов сайта с различными опциями. Она предоставляет гибкость в том, как авторы отображаются, а также в каких данных о них можно получить. В этой статье мы рассмотрим основные параметры функции и приведем несколько примеров ее использования.
wp_list_authors( string|array $args = '' ): void|string
Параметры
- $args (string|array): Массив или строка с параметрами для настройки отображения.
- orderby (string): Как сортировать авторов. Принимает значения:
nicenameemailurlregistereduser_nicenameuser_emailuser_urluser_registerednamedisplay_namepost_countIDmeta_valueuser_login
- order (string): Направление сортировки. Принимает ‘ASC’ (по возрастанию) или ‘DESC’ (по убыванию). По умолчанию ‘ASC’.
- number (int): Максимальное количество авторов для отображения. По умолчанию — все авторы.
- optioncount (bool): Показывать количество постов в скобках рядом с именем автора. По умолчанию false.
- exclude_admin (bool): Исключить учетную запись ‘admin’, если она существует. По умолчанию true.
- show_fullname (bool): Показывать полное имя автора. По умолчанию false.
- hide_empty (bool): Скрывать авторов без постов. По умолчанию true.
- feed (string): Если не пусто, показать ссылку на фид автора и использовать этот текст как параметр alt ссылки.
- feed_image (string): Если не пусто, показать изображение для ссылки на фид автора.
- feed_type (string): Тип фида, например, ‘rss2’, ‘atom’. По умолчанию используется значение
get_default_feed(). - echo (bool): Выводить результат или возвращать его. По умолчанию true.
- style (string): Формат вывода. Если ‘list’, каждый автор оборачивается в элемент
<li>, иначе авторы разделяются запятыми. - html (bool): Выводить в формате HTML или простом тексте. По умолчанию true.
- exclude (int[]|string): Массив или строка с ID авторов, которых нужно исключить.
- include (int[]|string): Массив или строка с ID авторов, которых нужно включить. По умолчанию пустая строка.
- orderby (string): Как сортировать авторов. Принимает значения:
Возвращаемое значение
Функция возвращает void, если параметр echo равен true, или строку со списком авторов, если echo равен false.
Пример 1: Получение списка авторов с полными именами и количеством постов
wp_list_authors( array(
'show_fullname' => 1,
'optioncount' => 1,
'orderby' => 'post_count',
'order' => 'DESC',
'number' => 3
) );
Вывод:
Andrew Anderson (48)
Harriett Smith (42)
Sally Smith (29)
В этом примере мы выводим список авторов, показывая полное имя и количество их постов. Список отсортирован по убыванию количества постов, и отображается максимум три автора. По умолчанию исключен администратор и скрыты авторы без постов.
Пример 2: Список авторов в формате списка
$args = array(
'orderby' => 'name',
'order' => 'ASC',
'number' => null,
'optioncount' => false,
'exclude_admin' => true,
'show_fullname' => false,
'hide_empty' => true,
'echo' => true,
'feed' => '',
'feed_image' => '',
'feed_type' => '',
'style' => 'list',
'html' => true
);
wp_list_authors( $args );
В этом примере список авторов будет выведен в формате <ul>, с сортировкой по имени в порядке возрастания. Авторы без постов не будут отображены, и администратор будет исключен.
Пример 3: Список авторов с RSS фидами
wp_list_authors( array(
'feed' => 'RSS Feed',
'feed_image' => 'link_to_image.jpg',
'optioncount' => true,
'show_fullname' => true,
) );
В данном примере мы отображаем список авторов с указанием количества их постов и полными именами. При этом рядом с именем каждого автора будет ссылка на RSS фид.
Заключение
Функция wp_list_authors() — мощный инструмент для отображения авторов на сайте WordPress. С помощью различных параметров вы можете настроить вывод информации в соответствии с вашими потребностями. Будь то простой список или более сложный вывод с RSS фидами и количеством постов, эта функция предоставляет вам все необходимые средства для реализации ваших идей.