img_caption_shortcode

Filters the default caption shortcode output.

Description

apply_filters( 'img_caption_shortcode', (string) $var, (array) $attr, (string) $content ); 

If the filtered output isn't empty, it will be used instead of generating the default caption template.

Parameters (3)

0. $var (string) => ''
The caption output. Default empty.
1. $attr (array)
Attributes of the caption shortcode.
2. $content (string)
The image element, possibly wrapped in a hyperlink.

Usage

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

Defined (1)

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

/wp-includes/media.php  
  1. $output = apply_filters( 'img_caption_shortcode', '', $attr, $content );