wp_get_attachment_caption() │ WP 4.6.0

Получает описание (подпись) указанного вложения-картинки.

Подпись и заголовок у вложения - это разные вещи, не путайте их:

Основа для: get_the_post_thumbnail_caption()

1 раз — 0.000544 сек (медленно) | 50000 раз — 0.36 сек (очень быстро) | PHP 7.0.8, WP 4.6

Хуки из функции

wp_get_attachment_caption

Возвращает

Строку|false. Текст подписи или false.

Использование

wp_get_attachment_caption( $post_id );

$post(число/WP_Post)

ID или объект вложения-картинки, подпись которой нужно получить.
Если не указать и текущая запись не является вложением (attachment), то функцию вернет false.
По умолчанию: null (текущий пост)

Примеры

0

#1 Получим подпись вложения-картинки

Допустим у нас есть вложение с ID 654 и подписью "Вот такую рыбу я поймал", тогда:

echo wp_get_attachment_caption( 654 ); //> выведет: Вот такую рыбу я поймал

Добавить свой пример

Список изменений

Код wp_get_attachment_caption() wp get attachment caption ^{WP 6.7.2}

function wp_get_attachment_caption( $post_id = 0 ) {
	$post_id = (int) $post_id;
	$post    = get_post( $post_id );

	if ( ! $post ) {
		return false;
	}

	if ( 'attachment' !== $post->post_type ) {
		return false;
	}

	$caption = $post->post_excerpt;

	/**
	 * Filters the attachment caption.
	 *
	 * @since 4.6.0
	 *
	 * @param string $caption Caption for the given attachment.
	 * @param int    $post_id Attachment ID.
	 */
	return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );
}

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

wp_attachment image (картинки вложения)

Картинки