Получение Описания Эскиза Записи – Функция get_the_post_thumbnail_caption()

# Получение Описания Эскиза Записи (GET_THE_POST_THUMBNAIL_CAPTION)

Функция get_the_post_thumbnail_caption() позволяет получить описание (подпись) эскиза записи (миниатюры). Чтобы отобразить результат, используйте функцию the_post_thumbnail_caption().

## Как работает описание миниатюры

Описание миниатюры задается при редактировании изображения в административной панели WordPress.

![Пример описания миниатюры](assets/uploads/2019/01/post_thumbnail_caption-example.png)

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

Функция использует wp_get_attachment_caption().

### Время выполнения
- Выполнение 1 раз — 0.001914 сек (очень медленно)
- Выполнение 50 000 раз — 0.85 сек (очень быстро)

**PHP**: 7.0.8, **WP**: 4.6

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

Функция возвращает строку, содержащую описание миниатюры записи.

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

```php
get_the_post_thumbnail_caption( $post );

Параметры

• $post (int|WP_Post) — ID записи или объект WP_Post.
  • По умолчанию: используется глобальная переменная $post.

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

Функция вернет пустую строку, если у миниатюры нет описания. Не путайте заголовок миниатюры с описанием.

echo get_the_post_thumbnail_caption( 6462 );

История изменений

• С версии: 4.6.0 — функция была введена в систему.

Код функции

Функция get_the_post_thumbnail_caption находится в файле wp-includes/post-thumbnail-template.php.

function get_the_post_thumbnail_caption( $post = null ) {
    $post_thumbnail_id = get_post_thumbnail_id( $post );

    if ( ! $post_thumbnail_id ) {
        return '';
    }

    $caption = wp_get_attachment_caption( $post_thumbnail_id );

    if ( ! $caption ) {
        $caption = '';
    }

    return $caption;
}

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

Функции, которые могут быть полезны при работе с миниатюрами:

• delete_post_thumbnail()
• get_post_thumbnail_id()
• get_the_post_thumbnail()
• get_the_post_thumbnail_url()
• has_post_thumbnail()
• set_post_thumbnail()
• set_post_thumbnail_size()
• the_post_thumbnail()
• the_post_thumbnail_caption()
• the_post_thumbnail_url()

Работа с изображениями

Полезные функции для работы с изображениями:

• add_image_size()
• get_intermediate_image_sizes()
• image_downsize()
• wp_get_attachment_image_url()

Дополнительные изоб��ажения

• wp_get_additional_image_sizes()
• wp_get_attachment_thumb_url()