How to use load_script_textdomain_relative_path filter in WordPress

load_script_textdomain_relative_path filter

Filters the relative path of scripts used for finding translation files.

To use load_script_textdomain_relative_path 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 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 modify_load_script_textdomain_relative_path_defaults which takes 2 parameters and we registered using add_filter. The first parameter load_script_textdomain_relative_path is the name of the hook, the second parameter modify_load_script_textdomain_relative_path_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.

Sometime, you have to remove a registered hook so you can use remove_filter to remove load_script_textdomain_relative_path filter.

Parameters

• $relative: (string|false) The relative path of the script. False if it could not be determined.
• $src: (string) The full source URL of the script.

Live Example 1: Basic Usage

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

    function weplugins_modify_load_script_textdomain_relative_path_defaults($relative, $src) { 
        // Update the $relative variable according to your website requirements and return this variable.
        return $relative; 
    }
    // add the filter
    add_filter("load_script_textdomain_relative_path", "weplugins_modify_load_script_textdomain_relative_path_defaults", 10, 2);
    

Live Example 2: Conditional Modification

Here’s how you can modify the $relative variable conditionally.

    function weplugins_conditional_load_script_textdomain_relative_path($relative, $src) {
        if (strpos($src, 'specific-script.js') !== false) {
            $relative = 'custom/path/to/translation';
        }
        return $relative;
    }
    add_filter("load_script_textdomain_relative_path", "weplugins_conditional_load_script_textdomain_relative_path", 10, 2);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("load_script_textdomain_relative_path", "weplugins_modify_load_script_textdomain_relative_path_defaults", 10, 2);
    

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 us and we’d be happy to assist you.