How to use customize_dynamic_setting_class filter in WordPress

customize_dynamic_setting_class filter

Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.

To use customize_dynamic_setting_class 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_customize_dynamic_setting_class_defaults which takes 3 parameters and we registered using add_filter. The first parameter customize_dynamic_setting_class is name of the hook, The second parameter weplugins_modify_customize_dynamic_setting_class_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 customize_dynamic_setting_class filter.

Parameters

Below are the 3 parameters required to use this hook.

• $setting_class : (string) WP_Customize_Setting or a subclass.
• $setting_id : (string) ID for dynamic setting, usually coming from $_POST[‘customized’].
• $setting_args : (array) WP_Customize_Setting or a subclass.

Live Example 1

Below is an example how you can use this hook.

    function weplugins_modify_customize_dynamic_setting_class_defaults($setting_class, $setting_id, $setting_args) { 
   
        // Update the $setting_class variable according to your website requirements and return this variable. You can modify the $setting_class variable conditionally too if you want.

        return $setting_class; 
    }
    // add the filter
    add_filter( "customize_dynamic_setting_class", "weplugins_modify_customize_dynamic_setting_class_defaults", 10, 3 );

Live Example 2

To remove a hook callback, use the example below.

    remove_filter( "customize_dynamic_setting_class", "weplugins_modify_customize_dynamic_setting_class_defaults", 10, 3 );

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

Live Example 3

This example shows how to conditionally change the setting class.

    function weplugins_modify_customize_dynamic_setting_class_defaults($setting_class, $setting_id, $setting_args) { 
        if ($setting_id === 'my_custom_setting') {
            $setting_class = 'My_Custom_Setting_Class';
        }
        return $setting_class; 
    }
    // add the filter
    add_filter( "customize_dynamic_setting_class", "weplugins_modify_customize_dynamic_setting_class_defaults", 10, 3 );

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.