Описание термина в WordPress (TERM_DESCRIPTION())

Функция TERM_DESCRIPTION() используется для получения описания термина, например, категории или метки, в WordPress. Давайте разберёмся, как она работает и как её использовать.

Основные сведения

Назначение функции

Эта функция позволяет получить описание термина. Обычно термины в WordPress — это катег��рии, метки и другие типы таксономий.

Используется в

• tag_description()
• category_description()
• get_the_archive_description()

Не имеет хуков

Функция не поддерживает хуки, что означает, что нельзя модифицировать её поведение с помощью стороннего кода.

Возвращаемое значение

Строка. Описание термина, если оно доступно.

Как использовать

Функция вызывается следующим образом:

term_description( $term, $deprecated );

Параметры

• $term (int): ID термина. По умолчанию используется текущий ID термина.
• $deprecated (null): Устаревший параметр. Не используется. По умолчанию равен null.

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

Пример 1: Получение описания текущего термина (категории, метки и т.д.)

$description = term_description();
echo $description;

Пример 2: Отображение описания термина таксономии MY_TAX с ID 28

echo 'Описание секции: ' . term_description( '28', 'my_tax' );

Код функции

Функция находится в файле wp-includes/category-template.php:

function term_description( $term = 0, $deprecated = null ) {
    if ( ! $term && ( is_tax() || is_tag() || is_category() ) ) {
        $term = get_queried_object();
        if ( $term ) {
            $term = $term->term_id;
        }
    }

    $description = get_term_field( 'description', $term );

    return is_wp_error( $description ) ? '' : $description;
}

Объяснение кода

• Проверка термина: Если переменная $term не указана и мы находимся на странице таксономии, то получаем текущий объект термина.
• Получение описания: Используется функция get_term_field(), чтобы извлечь описание термина.
• Возврат результата: Если функция get_term_field() возвращает ошибку, функция возвращает пустую строку.

Связанные функции

Вот несколько функций, связанных с терминами и таксономиями:

• category_description(): Получает описание категории.
• tag_description(): Получает описание метки.
• get_the_archive_description(): Получает описание архива.

Таксономии: категории, метки и другие

Функции для работы с таксономиями:

• get_terms(): Получает список терминов.
• get_taxonomies(): Получает доступные таксономии.
• register_taxonomy(): Регистрирует новую таксономию.

Заключение

Функция TERM_DESCRIPTION() — полезный инструмент для работы с описаниями терминов в WordPress. Используйте её, чтобы добавлять контекст к вашим категориям и меткам. Надеемся, что это объяснение помогло вам лучше понять функцию и готовить ваши контенты к лучшему отображению.