Функция term_description() используется для получения описания термина в WordPress. Это может быть полезно, когда вам нужно отобразить информацию о категории, метке или любом другом элементе таксономии на сайте.
term_description( int $term, null $deprecated = null ): string
Параметры
- $term (int, необязательный): ID термина, описание которого нужно получить. Если параметр не указан, функция вернёт описание текущего термина.
- $deprecated (null, необязательный): Устаревший параметр, не используемый с версии 4.9.2. По умолчанию —
null. (раньше был слаг таксономии, например:category,post_tag)
Возвращаемое значение
- string: Возвращает строку с описанием термина, если она доступна. В противном случае возвращается пустая строка.
Как работает функция
Эта функция была добавлена в WordPress начиная с версии 2.8 и используется для получения описания термина, который может быть присвоен на странице редактирования термина. Если ID термина не указан, функция возвращает описание текущего термина в запросе.
Результат оборачивается в теги <p>, что удобно для использования в HTML-коде.
Пример 1: Получение описания текущего термина
Когда вы хотите получить описание термина, связанного с текущим контекстом, вы можете использовать функцию без параметров:
$description = term_description();
if ( ! empty( $description ) ) {
echo '<h2>Описание текущего термина:</h2>';
echo $description; // Отобразит описание термина, если оно есть
} else {
echo 'Описание отсутствует.';
}
Пример 2: Получение описания термина по ID
Если вам нужно получить описание конкретного термина, например, с ID 123 в таксономии post_tag, вы можете сделать это следующим образом:
$term_id = 123;
$description = term_description( $term_id, 'post_tag' );
if ( ! empty( $description ) ) {
echo 'Описание метки с ID 123: ' . $description;
} else {
echo 'Описание для метки с ID 123 не найдено.';
}
Пример 3: Получение описания для пользовательской таксономии
Предположим, у вас есть пользовательская таксономия my_tax, и вы хотите получить её описание с ID 15:
$custom_term_id = 15;
$custom_description = term_description( $custom_term_id, 'my_tax' );
if ( ! empty( $custom_description ) ) {
echo 'Описание термина в пользовательской таксономии my_tax: ' . $custom_description;
} else {
echo 'Описание для термина в пользовательской таксономии my_tax не найдено.';
}
Пример 4: Проверка наличия описания термина
Вы можете также проверить, существует ли описание для термина, прежде чем его выводить:
$term_id = 10; // Замените на ID вашего термина
$description = term_description( $term_id );
if ( ! empty( $description ) ) {
echo '<p>' . $description . '</p>';
} else {
echo '<p>Описание термина отсутствует.</p>';
}
Заключение
Функция term_description() является простым и эффективным способом получения описания терминов в WordPress. Она позволяет разработчикам легко извлекать информацию о терминах и использовать её в своих темах и плагинах.