category_description()

Получает описание категории
Функция WordPress
INT 1.0.0
WordPress Icon

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

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

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

category_description( int $category ): string

Функция принимает один обязательный параметр:

  • $category (int) — ID категории. По умолчанию используется ID текущей категории.

Функция возвращает описание категории в виде строки, если оно доступно.

<?php
/**
 * Выводит описание категории с ID 5.
 */
$category_description = category_description(5);
echo $category_description;
?>

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

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

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


$category_description = category_description();
echo $category_description;

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

Отображение описания категории по ее ID


$category_id = 5;
$category_description = category_description($category_id);
echo $category_description;

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

Использование функции в шаблоне категории


$category_description = category_description();
if (!empty($category_description)) {
    echo '<div class="category-description">' . $category_description . '</div>';
}

В этом примере мы используем функцию category_description() для вывода описания текущей категории в шаблоне категории. Если описание доступно, оно обертывается в div-элемент с классом «category-description» и выводится на экран.

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


$category_id = 5;
$category_description = category_description($category_id);
if (!empty($category_description)) {
    echo '<div class="category-description">' . $category_description . '</div>';
}

В данном примере мы указываем ID категории в качестве параметра функции category_description() и выводим описание категории с указанным ID в шаблоне. Если описание доступно, оно обертывается в div-элемент с классом «category-description» и выводится на экран.

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

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

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

Если необходимо получить описание конкретной категории, то следует указать ее идентификатор в качестве параметра функции. Если идентификатор не указан, то по умолчанию будет использован идентификатор текущей категории.

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


$category_id = 5; // Идентификатор категории
$description = category_description($category_id);
echo $description;

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

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

Пример использования функции wp_update_category() для изменения описания категории:


$category_id = 5; // Идентификатор категории
$category_data = array(
    'cat_ID' => $category_id,
    'category_description' => 'Новое описание категории'
);
wp_update_category($category_data);

Можно ли использовать HTML в описании категории?

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

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


<p>Это описание категории с <strong>HTML-тегами</strong> и <a href="https://example.com">ссылкой</a>.</p>

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

Для того чтобы вывести описание категории на странице, можно использовать функцию category_description(). Она позволяет получить описание категории и вывести его на экран.

$category_description = category_description();
echo $category_description;

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

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

$category_id = get_queried_object_id();
$category = get_category($category_id);
$category->description = '';
wp_update_term($category_id, 'category', (array) $category);

Как проверить, есть ли описание у категории?

Если вам нужно проверить, есть ли описание у категории, можно воспользоваться функцией category_description() и проверить, не является ли возвращаемое значение пустой строкой.

$category_description = category_description();
if (!empty($category_description)) {
    echo 'Описание доступно';
} else {
    echo 'Описание отсутствует';
}

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

Для добавления описания категории при ее создании в WordPress, можно воспользоваться функцией wp_insert_category(). Эта функция позволяет создать новую категорию и указать ее описание.


$category_data = array(
    'cat_name' => 'Название категории',
    'category_description' => 'Описание категории'
);
$category_id = wp_insert_category( $category_data );

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

Для получения описания категории по ее ID в WordPress, используется функция category_description(). Она принимает ID категории в качестве параметра и возвращает описание этой категории, если оно доступно.


$category_id = 1;
$category_description = category_description( $category_id );
echo 'Описание категории: ' . $category_description;

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

Для изменения описания категории программно в WordPress, можно воспользоваться функцией wp_update_category(). Она позволяет обновить описание категории по ее ID.


$category_id = 1;
$category_data = array(
    'category_description' => 'Новое описание категории'
);
wp_update_category( $category_data );

Функция category_description() в WordPress позволяет получить описание категории по ее ID. Также с помощью других функций, таких как wp_insert_category() и wp_update_category(), можно добавлять и изменять описание категории программно. Это очень удобно для автоматизации процесса работы с категориями и обеспечения более гибкого управления контентом на сайте.

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

  • Функция get_category(): возвращает объект категории по ID.
  • Функция get_categories(): возвращает массив объектов категорий.
  • Функция get_category_by_slug(): возвращает объект категории по слагу.
  • Функция get_category_link(): возвращает URL ссылки на категорию.
  • Функция get_category_parents(): возвращает массив родительских категорий для указанной категории.
  • Функция get_the_category(): возвращает массив объектов категорий для текущего поста.
  • Функция single_cat_title(): выводит заголовок текущей категории.
  • Хук get_the_categories: позволяет изменить массив категорий для текущего поста.
  • Класс WP_Term: представляет термин (категорию) в WordPress.
Обсуждение