Функция the_post_thumbnail_caption() в WordPress выводит подпись (caption) к миниатюре записи (post thumbnail). Подпись — это текст, связанный с изображением, который можно добавить при редактировании медиафайлов в админ-панели WordPress. Эта функция полезна для отображения дополнительной информации о картинке прямо в шаблоне сайта.
the_post_thumbnail_caption( int|WP_Post $post = null )
Параметры:
$post(необязательный): идентификатор поста или объектWP_Post. Если параметр не указан, используется текущий пост из глобальной переменной$post.
Возвращаемое значение:
- Функция не возвращает значение, она выводит текст подписи миниатюры на экран. Если у миниатюры записи нет подписи, функция выведет пустую строку.
Когда использовать
Функцию можно использовать в шаблонах для отображения описания изображений, прикрепленных к постам. Это особенно полезно для фотогалерей, статей с большим количеством изображений или когда нужно показать подпись к картинке прямо под ней.
Пример 1: Вывод подписи миниатюры для текущего поста
Этот код выводит подпись миниатюры текущего поста внутри стандартного цикла WordPress:
<?php if ( has_post_thumbnail() ) : ?>
<figure>
<?php the_post_thumbnail( 'thumbnail' ); ?>
<figcaption><?php the_post_thumbnail_caption(); ?></figcaption>
</figure>
<?php endif; ?>
Пример 2: Вывод подписи для конкретного поста
Если вам нужно вывести подпись к миниатюре для конкретной записи по её ID, можно передать идентификатор записи в функцию:
<?php the_post_thumbnail_caption( 123 ); ?>
Пример 3: Использование подписи в галерее изображений
Для галерей изображений можно вывести подписи к каждому изображению. Пример кода, который выводит миниатюры постов с подписями в виде галереи:
<?php if ( have_posts() ) : ?>
<div class="gallery">
<?php while ( have_posts() ) : the_post(); ?>
<div class="gallery-item">
<?php if ( has_post_thumbnail() ) : ?>
<figure>
<?php the_post_thumbnail( 'medium' ); ?>
<figcaption><?php the_post_thumbnail_caption(); ?></figcaption>
</figure>
<?php endif; ?>
</div>
<?php endwhile; ?>
</div>
<?php endif; ?>
Как это работает
Функция the_post_thumbnail_caption() — это обертка над функцией get_the_post_thumbnail_caption(), которая возвращает строку с подписью миниатюры текущего поста. Если изображение не имеет подписи, функция возвращает пустую строку, и на экране ничего не выводится.
Чтобы добавить или отредактировать подпись к изображению, нужно зайти в медиа-библиотеку WordPress, выбрать нужное изображение и добавить текст в поле «Подпись» (Caption).
Заключение
Функция the_post_thumbnail_caption() полезна для вывода описания к изображению, прикрепленному к записи в WordPress. Ее можно использовать для создания более информативных и красивых интерфейсов, отображая подписи под изображениями.