How to use image_add_caption_text filter in WordPress

image_add_caption_text filter

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

To use image_add_caption_text filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_image_add_caption_text_defaults which takes 2 parameters and we registered it using add_filter. The first parameter image_add_caption_text is the name of the hook, the second parameter weplugins_modify_image_add_caption_text_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove image_add_caption_text filter.

Parameters

Below are the 2 parameters required to use this hook.

• $caption: (string) The original caption text.
• $id: (int) The attachment ID.

Live Example

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

Below is an example of how you can use this hook.

Example 1: Basic Usage

This example shows a basic modification of the caption text.

function weplugins_modify_image_add_caption_text_defaults($caption, $id) { 
    // Update the $caption variable according to your website requirements and return this variable.
    // You can modify the $caption variable conditionally too if you want.
    return $caption; 
}
// add the filter
add_filter("image_add_caption_text", "weplugins_modify_image_add_caption_text_defaults", 10, 2);

Example 2: Conditional Modification

This example demonstrates modifying the caption based on a condition.

function weplugins_modify_image_add_caption_text_conditional($caption, $id) {
    if ($id === 123) { // Condition based on attachment ID
        $caption = 'Custom Caption for ID 123';
    }
    return $caption;
}
// add the filter
add_filter("image_add_caption_text", "weplugins_modify_image_add_caption_text_conditional", 10, 2);

Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter("image_add_caption_text", "weplugins_modify_image_add_caption_text_defaults", 10, 2);

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you need any customization or have any trouble using this hook, please contact us. We’d be happy to assist you.