Exciting News! Flipper Code is now WePlugins! Same commitment to excellence, brand new identity.

How to use pre_set_theme_mod_name filter in WordPress

Sandeep Kumar Mishra
Sandeep Kumar Mishra
August 1, 2022
5 minutes read

pre_set_theme_mod_name filter

The dynamic portion of the hook name, $name, refers to the key name of the modification array. For example, ‘header_textcolor’, ‘header_image’, and so on depending on the theme options.

To use pre_set_theme_mod_name 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_set_theme_mod_name_defaults which takes 2 parameters and we registered using add_filter. The first parameter pre_set_theme_mod_name is the name of the hook. The second parameter weplugins_modify_pre_set_theme_mod_name_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_set_theme_mod_name filter.

Parameters

Below are the 2 parameters required to use this hook.

  • $value : (mixed) The new value of the theme modification.
  • $old_value : (mixed) The current value of the theme modification.

Live Example 1

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

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

Live Example 2

This example demonstrates how to use the hook to modify a specific theme mod.

    function weplugins_modify_header_textcolor($value, $old_value) {
        if ($old_value == '000000') {
            $value = 'ffffff';
        }
        return $value;
    }
    // add the filter
    add_filter("pre_set_theme_mod_header_textcolor", "weplugins_modify_header_textcolor", 10, 2);
    

Live Example 3

To remove a hook callback, use the example below.

    remove_filter("pre_set_theme_mod_name", "weplugins_modify_pre_set_theme_mod_name_defaults", 10, 2);
    

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

Access Premium WordPress Plugins

Contact Us

If you need any customization or help using this hook, feel free to Contact Us.

Sandeep Kumar Mishra

Sandeep Kumar Mishra

Sandeep Kumar Mishra writes about WordPress and Artificial Intelligence, offering tips and guides to help you master your website and stay updated with the latest tech trends.

Explore the latest in WordPress

Trying to stay on top of it all? Get the best tools, resources and inspiration sent to your inbox every Wednesday.