term_description()

Извлекает описание термина
Функция WordPress
INT 2.8.0
WordPress Icon

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

Функция term_description() возвращает описание термина (категории) по его ID. Если описание термина не задано, функция вернет пустую строку.

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

term_description( int $term, null $deprecated = null ): string

Функция term_description() принимает два параметра: $term (обязательный) и $deprecated (необязательный).

Параметр $term определяет ID термина, для которого нужно получить описание. По умолчанию, используется ID текущего термина.

Параметр $deprecated не используется и оставлен для обратной совместимости. По умолчанию, он равен null.

Функция term_description() возвращает описание термина в виде строки, если оно доступно. Если описание не задано, функция вернет пустую строку.

<?php
    // Получаем описание термина с ID 5
    $term_description = term_description(5);
    // Выводим описание термина
    echo $term_description;
?>

В этом примере мы используем функцию term_description() для получения описания термина с ID 5. Затем мы выводим описание на экран с помощью функции echo.

Обратите внимание, что если описание термина не задано, переменная $term_description будет содержать пустую строку.

Это было подробное описание функции term_description() в WordPress. Она позволяет получить описание термина по его ID и использовать его в своих проектах.

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

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


/**
 * Retrieves term description.
 *
 * @since 4.4.0
 *
 * @param int $term Optional. Term ID. Defaults to the current term ID.
 * @return string Term description, if available.
 */
function term_description( $term = 0 ) {
    $term = get_term( $term );
    if ( is_wp_error( $term ) ) {
        return '';
    }
    return apply_filters( 'term_description', $term->description, $term );
}

Функция term_description() используется для извлечения описания термина. Она принимает один необязательный параметр — ID термина, по умолчанию используется текущий ID термина.

Внутри функции сначала вызывается функция get_term() для получения объекта термина по его ID. Затем проверяется, является ли полученный термин ошибкой с помощью функции is_wp_error(). Если это так, то функция возвращает пустую строку.

В противном случае, функция возвращает описание термина, применяя фильтр term_description к полю description объекта термина.

Получение описания термина по его ID


$term_id = 5;
$description = term_description( $term_id );
echo $description;

В данном примере мы указываем ID термина, для которого хотим получить описание, и передаем его в функцию term_description(). Затем полученное описание выводится на экран с помощью функции echo.

Получение описания текущего термина


$description = term_description();
echo $description;

В этом примере не указан ID термина, поэтому функция term_description() будет использовать текущий ID термина. Описание текущего термина выводится на экран с помощью функции echo.

Получение описания термина с использованием устаревшего параметра


$term_id = 5;
$deprecated = null;
$description = term_description( $term_id, $deprecated );
echo $description;

В данном примере мы указываем ID термина и передаем вторым параметром устаревший параметр, который не используется. Описание термина выводится на экран с помощью функции echo.

Получение описания термина с использованием необязательного параметра


$term_id = 5;
$description = term_description( $term_id );
echo $description;

В этом примере мы указываем ID термина и не передаем второй параметр. Функция term_description() будет использовать текущий ID термина. Описание термина выводится на экран с помощью функции echo.

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

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

Функция term_description() используется для получения описания термина.

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


$term_id = 5;
$description = term_description( $term_id );
echo $description;

Как изменить описание термина?

Функция term_description() не предоставляет возможности изменять описание термина напрямую. Описание термина можно изменить через административный интерфейс WordPress.

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

Функция term_description() не предоставляет возможности удалить описание термина напрямую. Описание термина можно удалить через административный интерфейс WordPress.

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

Для проверки наличия описания у термина в WordPress можно использовать функцию term_description(). Она возвращает описание термина, если оно доступно.

Как вывести описание термина на странице?

Для вывода описания термина на странице можно использовать функцию term_description(). Она принимает необязательный параметр $term, который указывает ID термина. По умолчанию используется текущий ID термина.

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


$term_description = term_description();
echo $term_description;

Как добавить HTML-разметку к описанию термина?

Для добавления HTML-разметки к описанию термина можно использовать фильтр term_description. Этот фильтр позволяет изменить описание термина перед его выводом.

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


function custom_term_description($description) {
    $description = '<p>' . $description . '</p>';
    return $description;
}
add_filter('term_description', 'custom_term_description');

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

Для получения описания только для определенного термина, нужно передать его ID в качестве аргумента функции term_description(). Например:


$term_id = 5;
$description = term_description( $term_id );
echo $description;

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

Если вам нужно получить описание термина без HTML-тегов, вы можете использовать функцию strip_tags() для удаления всех тегов из строки. Вот пример:


$term_id = 5;
$description = term_description( $term_id );
$description_without_tags = strip_tags( $description );
echo $description_without_tags;

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

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


$term_id = 5;
$description = term_description( $term_id );
$trimmed_description = wp_trim_words( $description, 10 );
echo $trimmed_description;

Функция term_description() позволяет получить описание термина в WordPress. Вы можете получить описание только для определенного термина, удалить HTML-теги из описания или получить обрезанное описание. Эта функция очень полезна при работе с таксономиями и терминами в WordPress.

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

  • Функция get_term(): Возвращает объект термина по заданному ID.
  • Функция get_term_by(): Возвращает объект термина по указанному полю и значению.
  • Функция get_terms(): Возвращает массив объектов терминов для указанной таксономии.
  • Функция get_term_link(): Возвращает URL ссылку на страницу термина.
  • Класс WP_Term: Представляет объект термина WordPress.
Обсуждение