get_category_parents()
Получает список родительских категорий текущей категории. Список выводиться в порядке вложенности.
Можно указать чтобы названия родительских категорий были ссылками на сами категории (нечто вроде хлебных крошек).
С версии 4.8 функция стала обёрткой для get_term_parents_list(). А 4-ый параметр был отменен.
Хуков нет.
Возвращает
Строку|WP_Error. HTML код, список родительских категорий. Или объект WP_Error.
Использование
$cat_parents = get_category_parents( $id, $link, $separator, $nicename );
- $id(число) (обязательный)
- ID категории, для которой нужно вывести родительские категории.
- $link(логический)
- true - выведет список родительских категорий в виде ссылок на страницы категорий.
false - будут выведены названия.
По умолчанию: false - $separator(строка)
- Разделитель между названиями.
По умолчанию: '/' - $nicename(логический)
- true - выведет альтернативные названия (слаги) категорий (которые используются в УРЛах)
false - выедет реальные названия.
По умолчанию: false
Примеры
#1 Выведем родительские категории категории 10
В виде ссылок разделенных знаком ' » '. Ссылка на категорию 10 так же будет выведена.
<?php echo get_category_parents( 10, true, ' » '); ?>
#2 Получим топовый родительский элемент для вложенного элемента
Нужно получить первый (корневой) родительский элемент (термин) таксономии к текущему элементу. Т.е. у нас есть элемент таксономии, а нам нужно получить самый верхний элемент этого термина по иерархии.
Ответ смотрите в вопросе: Как получить элемент таксономии верхнего уровня в котором находится указанная запись (пост)?
Список изменений
| С версии 1.2.0 | Введена. |
| С версии 4.8.0 | The $visited parameter was deprecated and renamed to $deprecated. |
Код get_category_parents() get category parents WP 6.1.1
function get_category_parents( $category_id, $link = false, $separator = '/', $nicename = false, $deprecated = array() ) {
if ( ! empty( $deprecated ) ) {
_deprecated_argument( __FUNCTION__, '4.8.0' );
}
$format = $nicename ? 'slug' : 'name';
$args = array(
'separator' => $separator,
'link' => $link,
'format' => $format,
);
return get_term_parents_list( $category_id, 'category', $args );
}