How to use async_upload_type filter in WordPress

async_upload_type filter

The dynamic portion of the hook name, $type, refers to the attachment type.

To use the async_upload_type 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_async_upload_type_defaults which takes 1 parameter and is registered using add_filter. The first parameter async_upload_type is the name of the hook, the second parameter weplugins_modify_async_upload_type_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 to the registered function.

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

Parameters

Below is the 1 parameter required to use this hook.

• $id: (int) Uploaded attachment ID.

Live Example

Example 1

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

        function weplugins_modify_async_upload_type_defaults($id) { 
            // Update the $id variable according to your website requirements and return this variable. 
            // You can modify the $id variable conditionally too if you want.
            return $id; 
        }
        // Add the filter
        add_filter("async_upload_type", "weplugins_modify_async_upload_type_defaults", 10, 1);
    

Example 2

To remove a hook callback, use the example below.

        remove_filter("async_upload_type", "weplugins_modify_async_upload_type_defaults", 10, 1);
    

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

Example 3

Another way to modify the uploaded attachment ID conditionally.

        function weplugins_modify_async_upload_type_conditionally($id) { 
            if($id > 1000) {
                // Perform some action
                $id = $id + 1;
            }
            return $id; 
        }
        // Add the filter
        add_filter("async_upload_type", "weplugins_modify_async_upload_type_conditionally", 10, 1);
    

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.