get_term_parents_list()

Извлекает список родительских терминов с разделителем
Функция WordPress
INT 4.8.0
WordPress Icon
Содержание
  1. Описание функции
  2. Примеры использования
  3. Получение списка родительских терминов
  4. Форматирование списка терминов
  5. Создание ссылок на термины
  6. Включение текущего термина в список родителей
  7. Использование слагов терминов
  8. Изменение разделителя в списке терминов
  9. Вопросы и ответы
  10. Как получить список родительских терминов для определенного термина?
  11. Как изменить разделитель между терминами в списке родительских терминов?
  12. Как отобразить список родительских терминов без ссылок?
  13. Как получить только имена родительских терминов, без разделителя?
  14. Как получить список родительских терминов для нескольких терминов одновременно?
  15. Как получить список родительских терминов для определенной таксономии?
  16. Как получить список родительских терминов без указания конкретного термина?
  17. Как получить список родительских терминов без указания конкретной таксономии?
  18. Как проверить, существуют ли родительские термины для определенного термина?
  19. Связанные элементы

Описание функции

Функция get_term_parents_list() возвращает список родительских терминов с разделителем.

Она используется для получения списка родительских терминов для указанного термина в таксономии. Результатом работы функции является строка, содержащая список родительских терминов, разделенных заданным разделителем.

Функция может быть полезна при создании навигации по таксономиям или отображении иерархии терминов.

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

get_term_parents_list( int $term_id, string $taxonomy, string|array $args = array() ): string|WP_Error

Функция get_term_parents_list() принимает следующие параметры:

  • $term_id (обязательный) — идентификатор термина.
  • $taxonomy (обязательный) — название таксономии.
  • $args (необязательный) — массив дополнительных аргументов.
  • $term_id (int, обязательный) — идентификатор термина.
  • $taxonomy (string, обязательный) — название таксономии.
  • $args (string|array, необязательный) — массив дополнительных аргументов.
    • format (string) — формат отображения терминов (имена или слаги). Принимает значения ‘name’ или ‘slug’. По умолчанию ‘name’.
    • separator (string) — разделитель между терминами. По умолчанию ‘/’.
    • link (bool) — форматировать ли термины в виде ссылок. По умолчанию true.
    • inclusive (bool) — включать ли указанный термин в список родителей. По умолчанию true.

Функция возвращает список родительских терминов в виде строки. В случае успешного выполнения функция возвращает строку с родительскими терминами. В случае ошибки возвращает объект WP_Error или пустую строку.

<?php
$term_id = 123; // идентификатор термина
$taxonomy = 'category'; // название таксономии
// Дополнительные аргументы
$args = array(
  'format' => 'name', // отображать термины по их именам
  'separator' => ' > ', // разделитель между терминами
  'link' => true, // форматировать термины в виде ссылок
  'inclusive' => true // включать указанный термин в список родителей
);
// Получение списка родительских терминов
$parents_list = get_term_parents_list( $term_id, $taxonomy, $args );
echo $parents_list; // вывод списка родительских терминов
?>

В этом примере мы указываем идентификатор термина и название таксономии, а также задаем дополнительные аргументы для форматирования результата. Затем мы вызываем функцию get_term_parents_list() с этими параметрами и выводим результат.

Примеры использования

Получение списка родительских терминов


$term_id = 123; // ID термина
$taxonomy = 'category'; // Название таксономии
$parents_list = get_term_parents_list($term_id, $taxonomy);
echo $parents_list;

В данном примере мы используем функцию get_term_parents_list() для получения списка родительских терминов для заданного термина с указанным ID ($term_id) и названием таксономии ($taxonomy). Результат будет выведен с помощью функции echo.

Форматирование списка терминов


$term_id = 123; // ID термина
$taxonomy = 'category'; // Название таксономии
$args = array(
    'format' => 'slug' // Использование слагов терминов
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

В данном примере мы используем функцию get_term_parents_list() для получения списка родительских терминов для заданного термина с указанным ID ($term_id) и названием таксономии ($taxonomy). В опциональном массиве аргументов ($args) мы указываем формат вывода списка терминов, в данном случае используем слаги терминов. Результат будет выведен с помощью функции echo.

Создание ссылок на термины


$term_id = 123; // ID термина
$taxonomy = 'category'; // Название таксономии
$args = array(
    'link' => true // Создание ссылок на термины
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

В данном примере мы используем функцию get_term_parents_list() для получения списка родительских терминов для заданного термина с указанным ID ($term_id) и названием таксономии ($taxonomy). В опциональном массиве аргументов ($args) мы указываем создание ссылок на термины. Результат будет выведен с помощью функции echo.

Включение текущего термина в список родителей


$term_id = 123; // ID термина
$taxonomy = 'category'; // Название таксономии
$args = array(
    'inclusive' => true // Включение текущего термина в список родителей
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

В данном примере мы используем функцию get_term_parents_list() для получения списка родительских терминов для заданного термина с указанным ID ($term_id) и названием таксономии ($taxonomy). В опциональном массиве аргументов ($args) мы указываем включение текущего термина в список родителей. Результат будет выведен с помощью функции echo.

Использование слагов терминов


$term_id = 123; // ID термина
$taxonomy = 'category'; // Название таксономии
$args = array(
    'format' => 'slug' // Использование слагов терминов
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

В данном примере мы используем функцию get_term_parents_list() для получения списка родительских терминов для заданного термина с указанным ID ($term_id) и названием таксономии ($taxonomy). В опциональном массиве аргументов ($args) мы указываем использование слагов терминов. Результат будет выведен с помощью функции echo.

Изменение разделителя в списке терминов


$term_id = 123; // ID термина
$taxonomy = 'category'; // Название таксономии
$args = array(
    'separator' => '|' // Изменение разделителя в списке терминов
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

В данном примере мы используем функцию get_term_parents_list() для получения списка родительских терминов для заданного термина с указанным ID ($term_id) и названием таксономии ($taxonomy). В опциональном массиве аргументов ($args) мы указываем изменение разделителя в списке терминов на символ «|». Результат будет выведен с помощью функции echo.

Вопросы и ответы

Как получить список родительских терминов для определенного термина?

Функция get_term_parents_list() позволяет получить список родительских терминов для определенного термина в WordPress.

Для этого необходимо передать в функцию следующие параметры:

  • $term_id — идентификатор термина, для которого нужно получить список родительских терминов;
  • $taxonomy — название таксономии, к которой относится термин;
  • $args (опционально) — массив дополнительных аргументов.

Функция возвращает список родительских терминов в виде строки или объект WP_Error в случае ошибки.

Пример использования функции:


$term_id = 42;
$taxonomy = 'category';
$args = array(
  'format' => 'slug',
  'separator' => ' > ',
  'link' => false,
  'inclusive' => false
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

Как изменить разделитель между терминами в списке родительских терминов?

По умолчанию разделитель между терминами в списке родительских терминов установлен как «/». С помощью функции get_term_parents_list() можно легко изменить этот разделитель.

Для этого нужно в массиве $args указать параметр 'separator' со значением нового разделителя.

Пример использования:


$term_id = 42;
$taxonomy = 'category';
$args = array(
  'separator' => ' > '
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

Как отобразить список родительских терминов без ссылок?

По умолчанию список родительских терминов, возвращаемый функцией get_term_parents_list(), отображается в виде ссылок на соответствующие термины. С помощью параметра 'link' можно отобразить список без ссылок.

Для этого в массиве $args нужно указать параметр 'link' со значением false.

Пример использования:


$term_id = 42;
$taxonomy = 'category';
$args = array(
  'link' => false
);
$parents_list = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents_list;

Как получить только имена родительских терминов, без разделителя?

Функция get_term_parents_list() возвращает список родительских терминов с разделителем по умолчанию. Если вам нужно получить только имена родительских терминов без разделителя, вы можете использовать опцию 'format' и установить ее в значение 'name'.


$term_id = 42;
$taxonomy = 'category';
$args = array(
    'format' => 'name'
);
$parents = get_term_parents_list($term_id, $taxonomy, $args);
echo $parents;

Как получить список родительских терминов для нескольких терминов одновременно?

Если вам нужно получить список родительских терминов для нескольких терминов одновременно, вы можете использовать цикл для обработки каждого термина.


$term_ids = array(42, 53, 67);
$taxonomy = 'category';
foreach ($term_ids as $term_id) {
    $parents = get_term_parents_list($term_id, $taxonomy);
    
    echo $parents;
}

Как получить список родительских терминов для определенной таксономии?

Если вам нужно получить список родительских терминов только для определенной таксономии, вы можете указать имя таксономии вторым параметром функции get_term_parents_list().


$term_id = 42;
$taxonomy = 'category';
$parents = get_term_parents_list($term_id, $taxonomy);
echo $parents;

Как получить список родительских терминов без указания конкретного термина?

Функция get_term_parents_list() позволяет получить список родительских терминов для определенной таксономии без указания конкретного термина. Для этого необходимо передать в функцию ID таксономии и не указывать ID термина.

Пример использования:


$taxonomy = 'category';
$parents = get_term_parents_list(0, $taxonomy);
echo $parents;

В данном примере мы получаем список родительских терминов для таксономии «category» без указания конкретного термина. Результат будет выведен на экран.

Как получить список родительских терминов без указания конкретной таксономии?

Функция get_term_parents_list() также позволяет получить список родительских терминов без указания конкретной таксономии. Для этого необходимо передать в функцию ID термина и не указывать название таксономии.

Пример использования:


$term_id = 10;
$parents = get_term_parents_list($term_id, '');
echo $parents;

В данном примере мы получаем список родительских терминов для термина с ID 10 без указания конкретной таксономии. Результат будет выведен на экран.

Как проверить, существуют ли родительские термины для определенного термина?

Функция get_term_parents_list() также может быть использована для проверки наличия родительских терминов для определенного термина. Для этого необходимо передать в функцию ID термина и проверить возвращаемое значение.

Пример использования:


$term_id = 10;
$parents = get_term_parents_list($term_id, '');
if (empty($parents)) {
    echo 'Родительские термины отсутствуют.';
} else {
    echo 'Родительские термины существуют.';
}

В данном примере мы проверяем наличие родительских терминов для термина с ID 10. Если родительские термины отсутствуют, будет выведено сообщение «Родительские термины отсутствуют.». В противном случае будет выведено сообщение «Родительские термины существуют.».

Связанные элементы

  • Функция get_term_children(): Возвращает дочерние термины для указанного термина.
  • Функция get_term_by(): Возвращает термин по указанным параметрам.
  • Функция get_term(): Возвращает объект термина по указанному ID.
  • Функция get_terms(): Возвращает массив терминов, удовлетворяющих указанным параметрам.
  • Функция get_term_link(): Возвращает ссылку на страницу термина.
  • Функция get_term_meta(): Возвращает значение мета-поля для указанного термина.
  • Хук pre_get_terms: Позволяет изменить параметры запроса для получения терминов.
  • Хук get_terms: Позволяет изменить результат запроса для получения терминов.
  • Класс WP_Term_Query: Класс для выполнения запросов к терминам.
Обсуждение