image_add_caption_text

Filters the caption text.

Description

apply_filters( 'image_add_caption_text', (string) $caption, (int) $id ); 

Note: If the caption text is empty, the caption shortcode will not be appended to the image HTML when inserted into the editor.

Passing an empty value also prevents the Filters from being evaluated at the end of image_add_caption().

Parameters (2)

0. $caption (string)
The original caption text.
1. $id (int)
The attachment ID.

Usage

To run the hook, copy the example below.
  1. $caption = apply_filters( 'image_add_caption_text', $caption, $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 image_add_caption_text callback 
  2. function filter_image_add_caption_text( $caption, $id ) { 
  3. // make filter magic happen here... 
  4. return $caption
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'image_add_caption_text', 'filter_image_add_caption_text', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'image_add_caption_text', 'filter_image_add_caption_text', 10, 2 ); 

Defined (1)

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

/wp-admin/includes/media.php  
  1. $caption = apply_filters( 'image_add_caption_text', $caption, $id );