How to use get_image_tag_class filter in WordPress

Filters the value of the attachment’s image tag class attribute.

To use get_image_tag_class 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_get_image_tag_class_defaults which takes 4 parameters and we registered using add_filter. The first parameter get_image_tag_class is the name of the hook, The second parameter modify_get_image_tag_class_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 get_image_tag_class filter.

Parameters

Below are the 4 parameters required to use this hook.

• $class : (string) CSS class name or space-separated list of classes.
• $id : (int) Attachment ID.
• $align : (string) Part of the class name for aligning the image.
• $size : (string|int[]) Requested image size. Can be any registered image size name, or an array of width and height values in pixels (in that order).

Live Example

Example 1: Adding a Custom Class to Image Tags

This example demonstrates how to add a custom class to all image tags.

function weplugins_add_img_class( $class ) {
    return $class . ' img-fluid';
}
add_filter( 'get_image_tag_class', 'weplugins_add_img_class' );

Example 2: Modifying Image Tag Class Conditionally

Below is an example of how you can use this hook to modify the image tag class based on certain conditions.

function weplugins_modify_get_image_tag_class_defaults($class, $id, $align, $size) { 
    // Update the $class variable according to your website requirements and return this variable.
    return $class; 
}
// Add the filter
add_filter( "get_image_tag_class", "weplugins_modify_get_image_tag_class_defaults", 10, 4 );

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

remove_filter( "get_image_tag_class", "weplugins_modify_get_image_tag_class_defaults", 10, 4 );

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, feel free to Contact Us.