wp_get_attachment_caption() WordPress Function
The wp_get_attachment_caption() function is used to get the caption for an attachment. This function can be used with any type of attachment, including images, audio files, and videos.
wp_get_attachment_caption( int $post_id ) #
Retrieves the caption for an attachment.
Parameters
- $post_id
(int)(Optional) Attachment ID. Default is the ID of the global
$post.
Return
(string|false) Attachment caption on success, false on failure.
Source
File: wp-includes/post.php
function wp_get_attachment_caption( $post_id = 0 ) {
$post_id = (int) $post_id;
$post = get_post( $post_id );
if ( ! $post ) {
return false;
}
if ( 'attachment' !== $post->post_type ) {
return false;
}
$caption = $post->post_excerpt;
/**
* Filters the attachment caption.
*
* @since 4.6.0
*
* @param string $caption Caption for the given attachment.
* @param int $post_id Attachment ID.
*/
return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Introduced. |