Функция WP_GET_POST_TAGS() в WordPress: описание, параметры, примеры

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

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

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

Функция может вернуть:

  • Array — массив объектов WP_Term, содержащий информацию о тегах.
  • Array — пустой массив, если теги не найдены.
  • WP_Error — объект ошибки, если таксономия 'post_tag' не существует.

Синтаксис

wp_get_post_tags( $post_id, $args );

Параметры

  • $post_id (int) — ID записи. Этот параметр не устанавливает значение по умолчанию, по��тому вам нужно указать ID конкретного поста.
  • $args (array) — параметры запроса тегов. Дополнительные параметры можно узнать в документации WP_Term_Query. По умолчанию — пустой массив.

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

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

Предположим, у вашего поста есть теги: tag2, tag5, tag6. Чтобы получить эти теги, используйте следующий код:

$tags = wp_get_post_tags( $post->ID );
print_r( $tags );

Результат выполнения этого кода:

Array (
   [0] => stdClass Object (
           [term_id] => 4
           [name] => tag2
           [slug] => tag2
           [term_group] => 0
           [term_taxonomy_id] => 4
           [taxonomy] => post_tag
           [description] => 
           [parent] => 0
           [count] => 7
       )

   [1] => stdClass Object (
           [term_id] => 7
           [name] => tag5
           [slug] => tag5
           [term_group] => 0
           [term_taxonomy_id] => 7
           [taxonomy] => post_tag
           [description] => 
           [parent] => 0
           [count] => 6
       )

   [2] => stdClass Object (
           [term_id] => 16
           [name] => tag6
           [slug] => tag6
           [term_group] => 0
           [term_taxonomy_id] => 16
           [taxonomy] => post_tag
           [description] => 
           [parent] => 0
           [count] => 2
       )
)

Пример 2: Получение списка ID тегов текущего поста

Если вам нужны только ID тегов, используйте следующий код:

global $post;
$tag_ids = wp_get_post_tags( $post->ID, array( 'fields' => 'ids' ) );
// $tag_ids равно [ 4, 7, 16 ]

Изменения

Функция wp_get_post_tags() была введена в версии WordPress 2.3.0.

Код функции

Вот как выглядит реализация функции:

function wp_get_post_tags( $post_id = 0, $args = array() ) {
    return wp_get_post_terms( $post_id, 'post_tag', $args );
}

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

Заключение

Функция wp_get_post_tags() — это простой способ извлечь теги из записи в WordPress. Использование этой функции поможет вам организовать и управлять контентом, а также улучшить его доступность для пользователей и поисковых систем.

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *