WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_the_post_thumbnail_caption()

get_the_post_thumbnail_caption( int|WP_Post $post = null ): string

In this article

Back to top

Returns the post thumbnail caption.

Parameters

$postint|WP_Postoptional
Post ID or WP_Post object. Default is global $post.

Default:null

Return

string Post thumbnail caption.

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

View all references View on Trac View on GitHub

UsesDescription
wp_get_attachment_caption()wp-includes/post.php

Retrieves the caption for an attachment.

get_post_thumbnail_id()wp-includes/post-thumbnail-template.php

Retrieves the post thumbnail ID.

Used byDescription
the_post_thumbnail_caption()wp-includes/post-thumbnail-template.php

Displays the post thumbnail caption.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.