apply_filters( 'img_caption_shortcode', string $output, array $attr, string $content )
- Since
- 2.6.0
Filters the default caption shortcode output.
Description
If the filtered output isn't empty, it will be used instead of generating the default caption template.
Compatibility
- WordPress
- since 2.6.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
$outputstring- The caption output. Default empty.
$attrarray- Attributes of the caption shortcode.
$contentstring- The image element, possibly wrapped in a hyperlink.
Where this hook fires · 1
wp-includes/media.php:2552img_caption_shortcode()
Source code
* @see img_caption_shortcode() * * @param string $output The caption output. Default empty. * @param array $attr Attributes of the caption shortcode. * @param string $content The image element, possibly wrapped in a hyperlink. */ $output = apply_filters( 'img_caption_shortcode', '', $attr, $content ); if ( ! empty( $output ) ) { return $output; } $atts = shortcode_atts(Changelog
Introduced in 2.6.0. Unchanged from 6.7.7 through 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.