wp_get_attachment_caption

Filters the attachment caption.

Description

apply_filters( 'wp_get_attachment_caption', (string) $caption, (int) $post_id ); 

Parameters (2)

0. $caption (string)
Caption for the given attachment.
1. $post_id (int)
Attachment ID.

Usage

To run the hook, copy the example below.
  1. $caption = apply_filters( 'wp_get_attachment_caption', $caption, $post_id ); 
  2.  
  3. if ( !empty( $caption ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the wp_get_attachment_caption callback 
  2. function filter_wp_get_attachment_caption( $caption, $post_id ) { 
  3. // make filter magic happen here... 
  4. return $caption
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_get_attachment_caption', 'filter_wp_get_attachment_caption', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_get_attachment_caption', 'filter_wp_get_attachment_caption', 10, 2 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/post.php  
  1. return apply_filters( 'wp_get_attachment_caption', $caption, $post->ID );