wppaste
WordPress

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

Since
4.1.0
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().

Compatibility

WordPress
since 4.1.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

$captionstring
The original caption text.
$idint
The attachment ID.

Where this hook fires · 1

  • wp-admin/includes/media.php:204image_add_caption()

Source code

View on Trac View on GitHub 

	 *	 * @since 4.1.0	 *	 * @param string $caption The original caption text.	 * @param int    $id      The attachment ID.	 */	$caption = apply_filters( 'image_add_caption_text', $caption, $id ); 	/**	 * Filters whether to disable captions.	 *	 * Prevents image captions from being appended to image HTML when inserted into the editor.	 *

Changelog

Introduced in 4.1.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.