wpseek.com
A WordPress-centric search engine for devs and theme authors



get_the_post_thumbnail_caption › WordPress Function

Since4.6.0
Deprecatedn/a
› get_the_post_thumbnail_caption ( $post = null )
Parameters:
  • (int|WP_Post|null) $post Optional. Post ID or WP_Post object. Default is global `$post`.
    Required: No
    Default: null
Returns:
  • (string) Post thumbnail caption.
Defined at:
Codex:

Returns the post thumbnail caption.



Related Functions: the_post_thumbnail_caption, get_the_post_thumbnail, get_the_post_thumbnail_url, get_the_post_navigation, get_the_posts_navigation

Source 

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