wppaste
WordPress

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

Since
3.7.0
Filters the width of an image's caption.

Description

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.

Compatibility

WordPress
since 3.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$widthint
Width of the caption in pixels. To remove this inline style, return zero.
$attsarray
Attributes of the caption shortcode.
$contentstring
The image element, possibly wrapped in a hyperlink.

Where this hook fires · 1

  • wp-includes/media.php:2618img_caption_shortcode()

Source code

	 *	 * @param int    $width    Width of the caption in pixels. To remove this inline style,	 *                         return zero.	 * @param array  $atts     Attributes of the caption shortcode.	 * @param string $content  The image element, possibly wrapped in a hyperlink.	 */	$caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content ); 	$style = ''; 	if ( $caption_width ) {		$style = 'style="width: ' . (int) $caption_width . 'px" ';	}

Changelog

Introduced in 3.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.