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

Что делает эта функция?

Функция the_post_thumbnail_caption() выводит подпись к миниатюре записи. Миниатюра — это изображение, которое вы можете назначить записи в WordPress. Подпись добавляется при редактировании изображения в панели управления.

Как получить подпись миниатюры

Если вы хотите получить подпись для дальнейшей обработки в PHP, используйте функцию get_the_post_thumbnail_caption().

Как использовать функцию

Синтаксис

the_post_thumbnail_caption( $post );

Параметры

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

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

Функция ничего не возвращает (null), а просто выводит подпись.

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

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

Как работает функция

Код функции

Функция the_post_thumbnail_caption() находится в файле wp-includes/post-thumbnail-template.php. Ниже представлен код функции:

function the_post_thumbnail_caption( $post = null ) {
/**

• Применяет фильтры к подписи миниатюры записи.
• @since 4.6.0
• @param string $caption Подпись для данного вложения.
  */
  echo apply_filters( 'the_post_thumbnail_caption', get_the_post_thumbnail_caption( $post ) );
  }
  

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

Вот некоторые функции, с которыми можно работать в контексте миниатюр:

• delete_post_thumbnail() — удалить миниатюру записи.
• get_post_thumbnail_id() — получить ID миниатюры записи.
• get_the_post_thumbnail() — получить миниатюру записи.
• get_the_post_thumbnail_caption() — получить подпись миниатюры.
• has_post_thumbnail() — проверить, есть ли у записи миниатюра.

Заключение

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