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

Parameters

$postint|WP_Post|nulloptional

Post ID or WP_Post object. Default is global $post.Default: null

Return

string

Post thumbnail caption.

Uses · 2

• get_post_thumbnail_id()Retrieves the post thumbnail ID.
• wp_get_attachment_caption()Retrieves the caption for an attachment.

Used by · 1

• the_post_thumbnail_caption()Displays the post thumbnail caption.

Source

View on Trac ↗View on GitHub ↗

297function get_the_post_thumbnail_caption( $post = null ) {298	$post_thumbnail_id = get_post_thumbnail_id( $post );299 300	if ( ! $post_thumbnail_id ) {301		return '';302	}303 304	$caption = wp_get_attachment_caption( $post_thumbnail_id );305 306	if ( ! $caption ) {307		$caption = '';308	}309 310	return $caption;311}

History

Introduced in 4.6.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/post-thumbnail-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.