How to use gettext_with_context_domain filter in WordPress

gettext_with_context_domain filter

The dynamic portion of the hook name, $domain, refers to the text domain.

To use gettext_with_context_domain 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 modify_gettext_with_context_domain_defaults which takes 4 parameters and we registered using add_filter. The first parameter gettext_with_context_domain is name of the hook, The second parameter modify_gettext_with_context_domain_defaults is name of the function which needs 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.

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

Parameters

Below are the 4 parameters required to use this hook.

• $translation : (string) Translated text.
• $text : (string) Text to translate.
• $context : (string) Context information for the translators.
• $domain : (string) Text domain. Unique identifier for retrieving translated strings.

Live Example 1: Basic Usage

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

    function weplugins_modify_gettext_with_context_domain_defaults($translation, $text, $context, $domain) { 
        // Update the $translation variable according to your website requirements and return this variable. 
        // You can modify the $translation variable conditionally too if you want.
        return $translation; 
    }
    // add the filter
    add_filter("gettext_with_context_domain", "weplugins_modify_gettext_with_context_domain_defaults", 10, 4);
    

Live Example 2: Conditional Translation

Here’s how you can modify translations conditionally.

    function weplugins_modify_gettext_with_context_domain_defaults($translation, $text, $context, $domain) { 
        if ($text === 'Hello' && $context === 'greeting') {
            $translation = 'Namaste';
        }
        return $translation; 
    }
    // add the filter
    add_filter("gettext_with_context_domain", "weplugins_modify_gettext_with_context_domain_defaults", 10, 4);
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("gettext_with_context_domain", "weplugins_modify_gettext_with_context_domain_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 need customization or are having any trouble using this hook, please contact us and we’d be happy to assist you.