image_add_caption_shortcode

Filters the image HTML markup including the caption shortcode.

Description

apply_filters( 'image_add_caption_shortcode', (string) $shcode, (string) $html ); 

Parameters (2)

0. $shcode (string)
The image HTML markup with caption shortcode.
1. $html (string)
The image HTML markup.

Usage

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

Defined (1)

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

/wp-admin/includes/media.php  
  1. return apply_filters( 'image_add_caption_shortcode', $shcode, $html );