image_add_caption_text WordPress Filter Hook
The image_add_caption_text hook allows you to add a caption to an image in WordPress. This is useful if you want to provide a brief description of the image or if you want to credit the author.
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
Changelog
| Version | Description |
|---|---|
| 4.1.0 | Introduced. |