Функция GET_TAGS() в WordPress

Функция get_tags() позволяет получить массив объектов тегов. Теги можно получить по различным критериям, которые указываются в параметре $args.

Использование функции get_terms()

Функция get_tags() основана на функции get_terms(), которая служит для получения терминов определенной таксономии.

Хуки функции

• get_tags - хук, который позволяет изменить массив объектов терминов, возвращаемых для таксономии "post_tag".

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

Функция возвращает либо массив объектов WP_Term, либо количество тегов, либо объект ошибки WP_Error. Каждый объект массива имеет следующие свойства:

• term_id - ID тега;
• name - название тега;
• slug - уникальное имя (слаг);
• term_group - группа (не используется);
• term_taxonomy_id - ID таксономии (обычно совпадает с term_id);
• taxonomy - название таксономии;
• description - описание;
• parent - ID родительской таксономии (не используется для тегов);
• count - количество записей с этим тегом.

Шаблон использования

$terms = get_tags( [
    'number'       => 0,
    'offset'       => 0,
    'orderby'      => 'id',
    'order'        => 'ASC',
    'hide_empty'   => true,
    'fields'       => 'all',
    'slug'         => '',
    'hierarchical' => true,
    'name__like'   => '',
    'pad_counts'   => false,
    'get'          => '',
    'child_of'     => 0,
    'parent'       => '',
] );

Параметры args

Параметры для получения тегов можно передать в виде строки или массива. Список доступных параметров можно посмотреть в документации функции get_terms().

По умолчанию: ''.

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

Пример 1: Вывод списка тегов в виде ссылок

Ниже приведен пример, как вывести список тегов в виде ссылок на каждый тег. Для каждой ссылки устанавливается уникальный класс и атрибут title:

$tags = get_tags();
$html = '
';

foreach ( $tags as $tag ) {
    $tag_link = get_tag_link( $tag->term_id );

    $html .= "";
    $html .= "{$tag->name}";
}

$html .= '
';

echo $html;

Чangelog

• С версии 2.3.0 функция была введена.

Код функции get_tags()

function get_tags( $args = '' ) {
    $defaults = array( 'taxonomy' => 'post_tag' );
    $args     = wp_parse_args( $args, $defaults );

    $tags = get_terms( $args );

    if ( empty( $tags ) ) {
        $tags = array();
    } else {
        /**
         * Фильтрует массив объектов терминов, возвращаемых для таксономии 'post_tag'.
         *
         * @param WP_Term[]|int|WP_Error $tags Массив объектов терминов 'post_tag' или WP_Error, если такая таксономия не существует.
         * @param array                  $args Массив аргументов.
         */
        $tags = apply_filters( 'get_tags', $tags, $args );
    }

    return $tags;
}

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

Вот список функций, которые связаны с тегами в WordPress:

• edit_tag_link() - ссылка для редактирования тега.
• get_tag_link() - получение ссылки на тег.
• single_tag_title() - вывод названия тега.
• tag_description() - получение описания тега.
• tag_exists() - проверка существования тега.
• wp_generate_tag_cloud() - генерация облака тегов.
• wp_tag_cloud() - вывод облака тегов.