get_term_parents_list()
Получает список родителей указанного элемента таксономии.
В результате получим текст или ссылки разделенные указанным разделителем (запятая, слэш).
Работает на основе: get_ancestors()
Основа для: get_category_parents()
1 раз — 0.003063 сек (очень медленно) | 50000 раз — 14.40 сек (медленно) | PHP 7.1.2, WP 4.8
Хуков нет.
Возвращает
Строку|WP_Error
.
- Строку, содержащую ярлыки или называния терминов через разделитель (запятую). Или HTML код ссылок с названиями терминов.
- WP_Error, если таксономии не существует.
- Пустую строку, если не удалось получить термин.
Использование
get_term_parents_list( $term_id, $taxonomy, $args = array() );
- $term_id(число) (обязательный)
- ID термина.
- $taxonomy(строка) (обязательный)
- Название таксономии с которой будем работать.
- $args(строка/массив)
Массив доп. настроек. По умолчанию выглядит так:
$defaults = array( 'format' => 'name', 'separator' => '/', 'link' => true, 'inclusive' => true, );
-
$format(строка)
'name'
- выводит имена терминов.'slug'
- выводит ярлыки терминов.
По умолчанию: 'name'
-
$separator(строка)
Разделитель между названиями или ссылками (если установлен параметр link).
По умолчанию: '/' -
$link(логический)
- true - выводить названия в виде ссылок на термины.
- false - выводить названия просто текстом.
По умолчанию: true
- $inclusive(логический)
Включить в список текущий термин, для которого получаются родители или нет?
По умолчанию: true
-
Примеры
#1 Получим список родительских элементов таксономии
Этот пример выводит «хлебные крошки» для термина 593 (categories). Сам элемент также включен в цепочку ссылок.
echo get_term_parents_list( 593, 'wpfunccat', array( 'separator' => ' / ', ) ); /* <a href="/function-cat/taxonomy">Таксономии</a> / <a href="/function-cat/categories">Рубрики</a> / */
1.2) Если в параметрах указать link = false
echo get_term_parents_list( 593, 'wpfunccat', array( 'separator' => ' / ', 'link' => false, ) ); /* Таксономии / Рубрики / */
1.3) Если в параметрах указать format = 'slug'
echo get_term_parents_list( 593, 'wpfunccat', array( 'separator' => ' / ', 'format' => 'slug', 'link' => false, ) ); /* taxonomy / categories / */
Список изменений
С версии 4.8.0 | Введена. |