WP_GENERATE_TAG_CLOUD(): создание облака тегов в WordPress

## WP_GENERATE_TAG_CLOUD() │ WP 2.3.0

Функция wp_generate_tag_cloud() создаёт облако тегов (heatmap) на основе предоставленных данных.

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

Эта функция используется в wp_tag_cloud().

### Хуки функции

- tag_cloud_sort
- wp_generate_tag_cloud_data
- wp_generate_tag_cloud

### Возвращает

Строку или массив строк. Облако тегов будет представлено в виде строки или массива в зависимости от указанного аргумента format.

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

```php
wp_generate_tag_cloud( $tags, $args );

• $tags (WP_Term[]) (обязательный) — Массив объектов WP_Term, для которых необходимо создать облако тегов.
• $args (string|array) — Массив или строка аргументов для генерации облака тегов. По умолчанию: ''.

Аргументы

• smallest (int): Наименьший размер шрифта для отображения тегов. По умолчанию: 8 (пунктов).
• largest (int): Наибольший размер шрифта для отображения тегов. По умолчанию: 22 (пунктов).
• unit (string): Единица измерения для значения smallest и largest. По умолчанию: 'pt'.
• number (int): Количество тегов для возврата. Принимает положительное целое число или ноль для возврата всех тегов.
• format (string): Формат отображения облака тегов. Принимает значения 'flat', 'list' или 'array'. По умолчанию: 'flat'.
• separator (string): HTML или текст для разделения тегов. По умолчанию: новый перевод строки "n".
• orderby (string): Значение для сортировки тегов. Принимает значения 'name' или 'count'. По умолчанию: 'name'.
• order (string): Порядок сортировки тегов. Принимает значения 'ASC' (по восходящей), 'DESC' (по убывающей) или 'RAND' (случайный порядок). По умолчанию: 'ASC'.
• filter (int|true|false): Возможность фильтрации окончательного вывода. По умолчанию: 1.
• topic_count_text (array): Параметр для количества тегов (посредством _n_noop()).
• topic_count_text_callback (callable): Обратная функция для генерации текста по числу тегов.
• topic_count_scale_callback (callable): Обратная функция для определения значения масштабирования количества тегов.
• show_count (true|false|int): Возможность отображения количества тегов. Принимает 0, 1 или их логические эквиваленты.

Примеры

Чтобы получить категории и создать облако тегов из них:

$terms = get_terms( [ 'taxonomy' => 'category' ] );

$cloud = wp_generate_tag_cloud( $terms, [
    'echo' => false,
] );

echo $cloud;

В результате будет сгенерирован HTML-код, который выглядит примерно так:

WordPress
Author Features

Изменения

• С 2.3.0 — Функция была введена.
• С 4.8.0 — Добавлен аргумент show_count.

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

• edit_tag_link()
• get_tag_link()
• get_tags()
• single_tag_title()
• tag_description()
• tag_exists()
• wp_tag_cloud()

Заключение

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