How to use img_caption_shortcode filter in WordPress

img_caption_shortcode filter

If the filtered output isn’t empty, it will be used instead of generating the default caption template.

To use img_caption_shortcode 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 modify_img_caption_shortcode_defaults which takes 3 parameters and we registered using add_filter. The first parameter img_caption_shortcode is the name of the hook, The second parameter modify_img_caption_shortcode_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 img_caption_shortcode filter.

Parameters

Below are the 3 parameters required to use this hook.

• $output: (string) The caption output. Default empty.
• $attr: (array) Attributes of the caption shortcode.
• $content: (string) The image element, possibly wrapped in a hyperlink.

Live Example 1: Basic Usage

Here’s a basic example of how to use the img_caption_shortcode filter.

    add_filter( 'weplugins_img_caption_shortcode', 'weplugins_my_img_caption_shortcode', 10, 3 );
    function weplugins_my_img_caption_shortcode( $output, $attr, $content ) {
        $attr = shortcode_atts( array(
            'id'      => '',
            'align'   => 'alignnone',
            'width'   => '',
            'caption' => ''
        ), $attr );
    }
    

Live Example 2: Modifying Defaults

Below is an example of how you can modify the defaults using this hook.

    function weplugins_modify_img_caption_shortcode_defaults($output, $attr, $content) { 
        // Update the $output variable according to your website requirements and return this variable
        return $output; 
    }
    // add the filter
    add_filter( "weplugins_img_caption_shortcode", "weplugins_modify_img_caption_shortcode_defaults", 10, 3 );
    

Live Example 3: Removing a Hook

To remove a hook callback, use the example below.

    remove_filter( "weplugins_img_caption_shortcode", "weplugins_modify_img_caption_shortcode_defaults", 10, 3 );
    

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

Contact Us

If you’re having any trouble using this hook, please Contact Us and we’d be happy to assist you.