How to use load_textdomain_mofile filter in WordPress

load_textdomain_mofile filter

Filters MO file path for loading translations for a specific text domain.

To use load_textdomain_mofile 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.

At WePlugins, 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_textdomain_mofile_defaults which takes 2 parameters and we registered using add_filter. The first parameter load_textdomain_mofile is name of the hook, The second parameter modify_load_textdomain_mofile_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if 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 load_textdomain_mofile filter.

Parameters

Below are the 2 parameters required to use this hook:

• $mofile : (string) Path to the MO file.
• $domain : (string) Text domain. Unique identifier for retrieving translated strings.

Live Example 1

This example shows how to use the load_textdomain_mofile filter to load a custom translation file.

    add_filter( 'load_textdomain_mofile', 'weplugins_custom_translation_file', 10, 2 );

    function weplugins_custom_translation_file( $mofile, $domain ) {
        if ( 'textdomain' === $domain ) {
            $mofile = WP_LANG_DIR . '/textdomain/yourtranslationfile-' . get_locale() . '.mo';
        }
        return $mofile;
    }
    

Live Example 2

This example demonstrates modifying the $mofile variable according to your website requirements.

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

Live Example 3

To remove a hook callback, use the example below.

    remove_filter( "load_textdomain_mofile", "weplugins_modify_load_textdomain_mofile_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.