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.

$width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content ); 
                         
if ( !empty( $width ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the img_caption_shortcode_width callback 
function filter_img_caption_shortcode_width( $width, $atts, $content ) { 
    // make filter magic happen here... 
    return $width; 
}; 
         
// add the filter 
add_filter( 'img_caption_shortcode_width', 'filter_img_caption_shortcode_width', 10, 3 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'img_caption_shortcode_width', 'filter_img_caption_shortcode_width', 10, 3 );