How to use plugins_update_check_locales filter in WordPress

plugins_update_check_locales filter

Filters the locales requested for plugin translations.

To use plugins_update_check_locales 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_plugins_update_check_locales_defaults which takes 1 parameter and we registered using add_filter. The first parameter plugins_update_check_locales is the name of the hook, The second parameter weplugins_modify_plugins_update_check_locales_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 plugins_update_check_locales filter.

Parameters

Below the 1 parameter is required to use this hook.

• $locales : (array) Plugin locales. Default is all available locales of the site.

Live Example

Example 1: Basic Usage

Below is an example of how you can use this hook to modify the locales.

    function weplugins_modify_plugins_update_check_locales_defaults($locales) {
        // Update the $locales variable according to your website requirements and return this variable.
        // You can modify the $locales variable conditionally too if you want.
        return $locales;
    }
    // add the filter
    add_filter("plugins_update_check_locales", "weplugins_modify_plugins_update_check_locales_defaults", 10, 1);
    

Example 2: Conditional Locale Modification

If you want to conditionally modify the locales, you can do it like this:

    function weplugins_modify_plugins_update_check_locales_conditionally($locales) {
        if (is_admin()) {
            // Modify locales only for the admin area
            $locales[] = 'en_US';
        }
        return $locales;
    }
    // add the filter
    add_filter("plugins_update_check_locales", "weplugins_modify_plugins_update_check_locales_conditionally", 10, 1);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("plugins_update_check_locales", "weplugins_modify_plugins_update_check_locales_defaults", 10, 1);
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.