How to use pre_load_script_translations filter in WordPress

pre_load_script_translations filter

Returning a non-null value allows you to override the default logic, effectively short-circuiting the function.

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

Parameters

Below are the 4 parameters required to use this hook.

• $translations : (string|false|null) JSON-encoded translation data. Default null.
• $file : (string|false) Path to the translation file to load. False if there isn’t one.
• $handle : (string) Name of the script to register a translation domain to.
• $domain : (string) The text domain.

Live Example 1: Basic Usage

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

function weplugins_modify_pre_load_script_translations_defaults($translations, $file, $handle, $domain) { 
    // Update the $translations variable according to your website requirements and return this variable. 
    // You can modify the $translations variable conditionally too if you want.
    return $translations; 
}
// add the filter
add_filter( "pre_load_script_translations", "weplugins_modify_pre_load_script_translations_defaults", 10, 4 );

Live Example 2: Conditional Translation Updates

Sometimes you need to update translations conditionally. Here’s how you can do that:

function weplugins_conditional_pre_load_script_translations($translations, $file, $handle, $domain) {
    if ($domain === 'my-text-domain') {
        // Modify translations only for a specific domain
        $translations = 'my-updated-translations';
    }
    return $translations;
}
// add the filter
add_filter( "pre_load_script_translations", "weplugins_conditional_pre_load_script_translations", 10, 4 );

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

remove_filter( "pre_load_script_translations", "weplugins_modify_pre_load_script_translations_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’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.