wp_get_attachment_caption
Filters the attachment caption.
Usage
add_filter( 'wp_get_attachment_caption', 'wp_kama_get_attachment_caption_filter', 10, 2 ); /** * Function for `wp_get_attachment_caption` filter-hook. * * @param string $caption Caption for the given attachment. * @param int $post_id Attachment ID. * * @return string */ function wp_kama_get_attachment_caption_filter( $caption, $post_id ){ // filter... return $caption; }
- $caption(string)
- Caption for the given attachment.
- $post_id(int)
- Attachment ID.
Changelog
Since 4.6.0 | Introduced. |
Where the hook is called
wp_get_attachment_caption
wp-includes/post.php 6978
return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );