How to use async_update_translation filter in WordPress

async_update_translation filter

Filters whether to asynchronously update translation for core, a plugin, or a theme. To use the async_update_translation 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_update_translation_defaults which takes 2 parameters and we registered using add_filter. The first parameter async_update_translation is the name of the hook. The second parameter weplugins_modify_async_update_translation_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 async_update_translation filter.

Parameters

Below are the 2 parameters required to use this hook.

• $update : (bool) Whether to update.
• $language_update : (object) The update offer.

Live Example 1: Basic Usage

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

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

Live Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_filter("async_update_translation", "weplugins_modify_async_update_translation_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: Conditional Update

Here’s an example to conditionally update the translations based on specific criteria.

    function weplugins_custom_async_update_translation($update, $language_update) {
        // Conditionally modify the $update value
        if ($language_update->type === 'plugin') {
            $update = false; // Prevent update for plugins
        }
        return $update;
    }
    add_filter("async_update_translation", "weplugins_custom_async_update_translation", 10, 2);
    

Contact Us

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