get_the_post_thumbnail_caption() WP 4.6.0

Gets the post thumbnail caption (description).

The caption is specified when editing the image in the admin panel:

No Hooks.

Return

String. Post thumbnail caption.

Usage

get_the_post_thumbnail_caption( $post );

$post(int/WP_Post)

Post ID or WP_Post object.
Default: global $post

Examples

#1 Get a post thumbnail caption

The function will print an empty string if the thumbnail has no caption. Not confuse thumbnail title and thumbnail caption.

echo get_the_post_thumbnail_caption( 6462 );

Changelog

Code of get the post thumbnail caption: wp-includes/post-thumbnail-template.php ^{WP 5.2.4}

<?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;
}

Related Functions

From tag: caption (of image)

More from tag: Thumbnail (images)

More from category: Thumbnails

vladlu 100 — vlad.lu

Editors: kama 100