apply_filters( 'image_add_caption_text', string $caption, int $id )

Filters the caption text.

Description

Note: If the caption text is empty, the caption shortcode will not be appended to the image HTML when inserted into the editor.

Passing an empty value also prevents the ‘image_add_caption_shortcode’ Filters from being evaluated at the end of image_add_caption().

Parameters

$caption

(string) The original caption text.

$id

(int) The attachment ID.

Source

File: wp-admin/includes/media.php

View on Trac

Changelog

Version Description
4.1.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/image_add_caption_text