On this page
get_the_post_thumbnail_caption( int|WP_Post $post = null ): string
Returns the post thumbnail caption.
Parameters
Return
string Post thumbnail caption.
Source
File: wp-includes/post-thumbnail-template.php. View all references
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
Uses
| Uses | Description |
|---|---|
| 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 By
| Used By | Description |
|---|---|
| the_post_thumbnail_caption() wp-includes/post-thumbnail-template.php | Displays the post thumbnail caption. |
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_the_post_thumbnail_caption