How to use get_attached_file filter in WordPress

get_attached_file filter

Filters the attached file based on the given ID.

To use the get_attached_file filter, first, you have to register it using add_filter. You can write this code into the 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_get_attached_file_defaults which takes 2 parameters and we registered using add_filter. The first parameter get_attached_file is the name of the hook, the second parameter weplugins_modify_get_attached_file_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 the get_attached_file filter.

Parameters

Below are the 2 parameters required to use this hook.

• $file : (string|false) The file path to where the attached file should be, false otherwise.
• $attachment_id : (int) Attachment ID.

Live Example 1

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

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

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("get_attached_file", "weplugins_modify_get_attached_file_defaults", 10, 2);
    

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

Live Example 3

Another example where you can modify the file path based on certain conditions.

    function weplugins_custom_get_attached_file($file, $attachment_id) { 
        if ($attachment_id == 123) {
            $file = '/new/path/to/file.jpg';
        }
        return $file; 
    }
    // add the filter
    add_filter("get_attached_file", "weplugins_custom_get_attached_file", 10, 2);
    

Contact Us

If you need customization or have any trouble using this hook, please contact us.