How to use customize_dynamic_setting_args filter in WordPress

customize_dynamic_setting_args filter

For a dynamic setting to be registered, this filter must be employed to override the default false value with an array of args to pass to the WP_Customize_Setting constructor.

To use customize_dynamic_setting_args 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_customize_dynamic_setting_args_defaults which takes 2 parameters and we registered using add_filter. The first parameter customize_dynamic_setting_args is the name of the hook, The second parameter modify_customize_dynamic_setting_args_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 customize_dynamic_setting_args filter.

Parameters

Below are the 2 parameters required to use this hook.

• $setting_args : (false|array) The arguments to the WP_Customize_Setting constructor.
• $setting_id : (string) ID for dynamic setting, usually coming from $_POST[‘customized’].

Live Example

apply_filters( 'customize_dynamic_setting_args', false|array $setting_args, string $setting_id )

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

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

Example 1

Here’s how to modify the setting arguments to include a specific transport method.

    function weplugins_modify_customize_dynamic_setting_args_transport($setting_args, $setting_id) { 
        if ($setting_id == 'my_custom_setting') {
            $setting_args['transport'] = 'postMessage';
        }
        return $setting_args; 
    }
    add_filter( "customize_dynamic_setting_args", "weplugins_modify_customize_dynamic_setting_args_transport", 10, 2 );
    

Example 2

This example shows how to add default values to the setting arguments.

    function weplugins_modify_customize_dynamic_setting_args_defaults($setting_args, $setting_id) { 
        $setting_args['default'] = 'default_value';
        return $setting_args; 
    }
    add_filter( "customize_dynamic_setting_args", "weplugins_modify_customize_dynamic_setting_args_defaults", 10, 2 );
    

Example 3

In this example, we conditionally modify the setting arguments based on the setting ID.

    function weplugins_modify_customize_dynamic_setting_args_conditional($setting_args, $setting_id) { 
        if ($setting_id == 'specific_setting') {
            $setting_args['capability'] = 'edit_theme_options';
        }
        return $setting_args; 
    }
    add_filter( "customize_dynamic_setting_args", "weplugins_modify_customize_dynamic_setting_args_conditional", 10, 2 );
    

To remove a hook callback, use the example below.

remove_filter( "customize_dynamic_setting_args", "weplugins_modify_customize_dynamic_setting_args_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 need any customization or have trouble using this hook, please contact us.