get_the_post_thumbnail_caption( int|WP_Post $post = null )
Returns the post thumbnail caption.
Parameters
- $post
-
(Optional) Post ID or WP_Post object. Default is global
$post.Default value: null
Return
(string) Post thumbnail caption.
Source
File: wp-includes/post-thumbnail-template.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;
}
Changelog
| Version | Description |
|---|---|
| WP-4.6.0 | Introduced. |