img_caption_shortcode_width

Filters the width of an image's caption.

Description

apply_filters( 'img_caption_shortcode_width', (int) $width, (array) $atts, (string) $content ); 

By default, the caption is 10 pixels greater than the width of the image, to prevent post content from running up against a floated image.

Parameters (3)

0. $width (int)
Width of the caption in pixels. To remove this inline style, return zero.
1. $atts (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. $width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content ); 
  2.  
  3. if ( !empty( $width ) ) { 
  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_width callback 
  2. function filter_img_caption_shortcode_width( $width, $atts, $content ) { 
  3. // make filter magic happen here... 
  4. return $width
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'img_caption_shortcode_width', 'filter_img_caption_shortcode_width', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'img_caption_shortcode_width', 'filter_img_caption_shortcode_width', 10, 3 ); 

Defined (1)

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

/wp-includes/media.php  
  1. $caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content );