wp_tag_cloud()

Отображает облако меток
Функция WordPress
INT 2.3.0
WordPress Icon

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

Функция wp_tag_cloud() отображает облако тегов.

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

wp_tag_cloud( array|string $args = '' ): void|string|string[]

Функция wp_tag_cloud() принимает один параметр — массив или строку аргументов для отображения облака тегов. Подробные списки аргументов, которые могут быть переданы в $args, можно найти в функциях wp_generate_tag_cloud() и get_terms().

  • $args (массив или строка) — Опционально. Массив или строка аргументов для отображения облака тегов.
  • number (целое число) — Количество отображаемых тегов. Принимает любое положительное целое число или ноль для отображения всех. Значение по умолчанию: 45.
  • link (строка) — Определяет, отображать ли ссылки на редактирование терминов или постоянные ссылки на термины. Принимает значения ‘edit’ и ‘view’. Значение по умолчанию: ‘view’.
  • post_type (строка) — Тип записи. Используется для выделения соответствующего меню типа записи на связанной странице редактирования. По умолчанию используется первый тип записи, связанный с таксономией.
  • echo (логическое значение) — Определяет, нужно ли выводить результат или возвращать его. Значение по умолчанию: true.
  • smallest (целое число) — Наименьший размер шрифта для отображения тегов. В сочетании со значением $unit определяет единицу измерения размера текста CSS. Значение по умолчанию: 8 (pt).
  • largest (целое число) — Наибольший размер шрифта для отображения тегов. В сочетании со значением $unit определяет единицу измерения размера текста CSS. Значение по умолчанию: 22 (pt).
  • unit (строка) — Единица измерения размера текста CSS, используемая с $smallest и $largest. Принимает любую допустимую единицу измерения размера текста CSS. Значение по умолчанию: ‘pt’.
  • number (целое число) — Количество возвращаемых тегов. Принимает любое положительное целое число или ноль для возврата всех. Значение по умолчанию: 0.
  • format (строка) — Формат отображения облака тегов. Принимает значения ‘flat’ (теги разделены пробелами), ‘list’ (теги отображаются в неупорядоченном списке) или ‘array’ (возвращает массив). Значение по умолчанию: ‘flat’.
  • separator (строка) — HTML или текст, разделяющий теги. Значение по умолчанию: «n» (новая строка).
  • orderby (строка) — Поле, по которому сортируются теги. Принимает значения ‘name’ или ‘count’. Значение по умолчанию: ‘name’. Сортировка тегов также может быть изменена с помощью фильтра ‘tag_cloud_sort’.
  • order (строка) — Порядок сортировки тегов. Принимает значения ‘ASC’ (по возрастанию), ‘DESC’ (по убыванию) или ‘RAND’ (случайный порядок). Значение по умолчанию: ‘ASC’.
  • filter (целое число или логическое значение) — Включение или отключение фильтрации конечного вывода через ‘wp_generate_tag_cloud’. Значение по умолчанию: 1.
  • topic_count_text (массив) — Текст во множественном числе для количества тегов. Значение по умолчанию: null.
  • topic_count_text_callback (функция обратного вызова) — Функция обратного вызова, используемая для генерации текста во множественном числе для количества тегов на основе количества. Значение по умолчанию: null.
  • topic_count_scale_callback (функция обратного вызова) — Функция обратного вызова, используемая для определения значения масштабирования количества тегов. Значение по умолчанию: default_topic_count_scale().
  • show_count (логическое значение или целое число) — Определяет, нужно ли отображать количество тегов. Значение по умолчанию: 0.

Если аргумент ‘echo’ равен true или в случае ошибки, функция возвращает void. В противном случае функция возвращает облако тегов в виде строки или массива в зависимости от аргумента ‘format’.

<?php
$args = array(
    'number' => 20,
    'link' => 'view',
    'post_type' => 'post',
    'echo' => true,
    'smallest' => 10,
    'largest' => 18,
    'unit' => 'pt',
    'number' => 0,
    'format' => 'flat',
    'separator' => ' ',
    'orderby' => 'name',
    'order' => 'ASC',
    'filter' => 1,
    'topic_count_text' => null,
    'topic_count_text_callback' => null,
    'topic_count_scale_callback' => null,
    'show_count' => 0
);
wp_tag_cloud( $args );
?>

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

Отображение облака тегов


$args = array(
    'number' => 20,
    'link' => 'edit',
    'post_type' => 'post',
    'echo' => true
);
 
wp_tag_cloud( $args );

В этом примере используется функция wp_tag_cloud() для отображения облака тегов. Параметр $args является массивом или строкой аргументов для отображения облака тегов. В данном случае, мы указываем, что нужно отобразить 20 тегов, отображать ссылки для редактирования тегов, использовать тип записи «post» и вывести результат на экран.

Форматирование облака тегов


$args = array(
    'format' => 'list',
    'separator' => ', ',
    'orderby' => 'count',
    'order' => 'DESC',
    'filter' => false
);
 
$tag_cloud = wp_tag_cloud( $args );
 
if ( ! empty( $tag_cloud ) ) {
    echo '<ul>' . $tag_cloud . '</ul>';
}

В этом примере используется функция wp_tag_cloud() для отображения облака тегов в формате списка. Мы также указываем разделитель между тегами, сортировку по количеству использований тегов в порядке убывания, отключаем фильтрацию и сохраняем результат в переменную $tag_cloud. Затем мы проверяем, не пустой ли результат, и выводим его в виде неупорядоченного списка, если он не пустой.

Сортировка тегов


$args = array(
    'orderby' => 'name',
    'order' => 'ASC'
);
 
wp_tag_cloud( $args );

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

Ограничение количества тегов


$args = array(
    'number' => 10
);
 
wp_tag_cloud( $args );

В этом примере используется функция wp_tag_cloud() для отображения только 10 тегов.

Настройка размеров шрифта тегов


$args = array(
    'smallest' => 10,
    'largest' => 20,
    'unit' => 'px'
);
 
wp_tag_cloud( $args );

В этом примере используется функция wp_tag_cloud() для отображения облака тегов с настройкой размеров шрифта. Мы указываем, что самый маленький размер шрифта должен быть 10 пикселей, а самый большой — 20 пикселей, и единицей измерения шрифта должен быть пиксель.

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

Как изменить количество отображаемых тегов в облаке?

Для изменения количества отображаемых тегов в облаке используется параметр $args['number']. По умолчанию значение этого параметра равно 45. Чтобы изменить количество тегов, нужно передать желаемое число в этот параметр.

Пример кода:


$args = array(
    'number' => 20
);
wp_tag_cloud($args);

Как изменить размеры шрифта тегов в облаке?

Для изменения размеров шрифта тегов в облаке используются параметры $args['smallest'] и $args['largest']. По умолчанию, наименьший размер шрифта равен 8pt, а наибольший — 22pt. Чтобы изменить размеры шрифта, нужно передать желаемые значения в эти параметры.

Пример кода:


$args = array(
    'smallest' => 10,
    'largest' => 30
);
wp_tag_cloud($args);

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

Для изменения порядка сортировки тегов в облаке используется параметр $args['orderby']. По умолчанию, теги сортируются по имени. Чтобы изменить порядок сортировки, нужно передать желаемое значение в этот параметр.

Пример кода:


$args = array(
    'orderby' => 'count'
);
wp_tag_cloud($args);

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

Для изменения разделителя между тегами в облаке используется параметр separator. По умолчанию разделитель задан как символ новой строки «n». Чтобы изменить разделитель, нужно передать новое значение в параметр separator. Например:


$args = array(
    'separator' => ', ' // изменяем разделитель на запятую с пробелом
);
wp_tag_cloud($args);

Как отобразить количество тегов в облаке?

Для отображения количества тегов в облаке используется параметр show_count. По умолчанию количество тегов не отображается. Чтобы включить отображение количества тегов, нужно передать значение 1 в параметр show_count. Например:


$args = array(
    'show_count' => 1 // включаем отображение количества тегов
);
wp_tag_cloud($args);

Как изменить формат отображения облака тегов?

Для изменения формата отображения облака тегов используется параметр format. По умолчанию облако тегов отображается в формате «flat» (теги разделены пробелами). Чтобы изменить формат, нужно передать новое значение в параметр format. Допустимые значения: «flat», «list», «array». Например:


$args = array(
    'format' => 'list' // изменяем формат на список
);
wp_tag_cloud($args);

Как изменить ссылки на теги в облаке?

Для изменения ссылок на теги в облаке используется параметр link функции wp_tag_cloud(). По умолчанию значение этого параметра равно ‘view’, что означает отображение ссылок на теги в виде постоянных ссылок. Если нужно отобразить ссылки на редактирование тегов, то значение параметра следует изменить на ‘edit’.

Пример кода:


$args = array(
    'link' => 'edit',
);
wp_tag_cloud( $args );

Как изменить количество отображаемых тегов в облаке?

Для изменения количества отображаемых тегов в облаке используется параметр number функции wp_tag_cloud(). По умолчанию значение этого параметра равно 45. Чтобы отобразить все теги, следует установить значение параметра в 0.

Пример кода:


$args = array(
    'number' => 0,
);
wp_tag_cloud( $args );

Как изменить размеры шрифта тегов в облаке?

Для изменения размеров шрифта тегов в облаке используются параметры smallest, largest и unit функции wp_tag_cloud(). Параметр smallest задает минимальный размер шрифта, параметр largest задает максимальный размер шрифта, а параметр unit определяет единицу измерения размера шрифта (например, ‘pt’ — пункты).

Пример кода:


$args = array(
    'smallest' => 10,
    'largest' => 20,
    'unit' => 'pt',
);
wp_tag_cloud( $args );

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

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

  • Функция wp_generate_tag_cloud(): генерирует облако тегов на основе заданных аргументов.
  • Функция get_terms(): возвращает список терминов (тегов) для указанной таксономии.
  • Хук tag_cloud_sort: позволяет изменить способ сортировки тегов в облаке.
  • Хук wp_generate_tag_cloud: позволяет фильтровать окончательный вывод облака тегов.
  • Хук wp_tag_cloud_args: позволяет изменить аргументы, передаваемые в функцию wp_tag_cloud.
  • Хук wp_tag_cloud: позволяет изменить вывод облака тегов.
  • Класс WP_Term_Query: используется для выполнения запросов к базе данных терминов (тегов).
  • Класс WP_Term: представляет отдельный термин (тег) и предоставляет методы для работы с ним.
Обсуждение