How to use customize_value_id_base filter in WordPress

customize_value_id_base filter

The dynamic portion of the hook name, $id_base, refers to the base slug of the setting name, initialized from $this->id_data[‘base’].

To use the customize_value_id_base 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.

At WePlugins, we 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_value_id_base_defaults which takes 2 parameters and we registered using add_filter. The first parameter customize_value_id_base is the name of the hook. The second parameter weplugins_modify_customize_value_id_base_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 into the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_filter to remove the customize_value_id_base filter.

Parameters

Below are the 2 parameters required to use this hook.

• $default_value : (mixed) The setting default value. Default empty.
• $setting : (WP_Customize_Setting) The setting instance.

Live Example

apply_filters( "customize_value_{$id_base}", mixed $default_value, WP_Customize_Setting $setting )

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

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

Example 1: Basic Usage

This example demonstrates how to update the default value for a custom setting.

    function weplugins_modify_customize_value_id_base_defaults($default_value, $setting) {
        $default_value = 'New Default Value';
        return $default_value;
    }
    add_filter( "customize_value_id_base", "weplugins_modify_customize_value_id_base_defaults", 10, 2 );
    

Example 2: Conditional Modification

This example shows how to change the default value based on the setting ID.

    function weplugins_conditional_customize_value($default_value, $setting) {
        if ($setting->id == 'specific_setting_id') {
            $default_value = 'Conditional Default Value';
        }
        return $default_value;
    }
    add_filter( "customize_value_id_base", "weplugins_conditional_customize_value", 10, 2 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "customize_value_id_base", "weplugins_modify_customize_value_id_base_defaults", 10, 2 );
    

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