How to use file_is_displayable_image filter in WordPress

file_is_displayable_image filter

Filters whether the current image is displayable in the browser.

To use file_is_displayable_image 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_file_is_displayable_image_defaults which takes 2 parameters and we registered it using add_filter. The first parameter file_is_displayable_image is the name of the hook, The second parameter weplugins_modify_file_is_displayable_image_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 file_is_displayable_image filter.

Parameters

Below are the 2 parameters required to use this hook.

• $result : (bool) Whether the image can be displayed. Default true.
• $path : (string) Path to the image.

Live Example

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

Example 1: Basic Usage

In this example, we will modify the displayability of an image based on custom conditions.

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

Example 2: Removing the Hook

To remove a hook callback, use the example below.

        remove_filter("file_is_displayable_image", "weplugins_modify_file_is_displayable_image_defaults", 10, 2);
    

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

Example 3: Conditional Check

In this example, we will conditionally modify the displayability based on the image path.

        function weplugins_modify_file_is_displayable_image_conditional($result, $path) { 
            if (strpos($path, 'restricted') !== false) {
                $result = false;
            }
            return $result; 
        }
        // add the filter
        add_filter("file_is_displayable_image", "weplugins_modify_file_is_displayable_image_conditional", 10, 2);
    

Contact Us

If you need any customization or are having trouble using this hook, please contact us and we’d be happy to assist you.