How to use customize_save_validation_before action in WordPress

customize_save_validation_before action

Plugins can add just-in-time ‘customize_validate_{$this->ID’} filters at this point to catch any settings registered after customize_register. The dynamic portion of the hook name, $this->ID refers to the setting ID.

To use customize_save_validation_before action, first you have to register it using add_action. 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_execute_on_customize_save_validation_before_event which takes 1 parameter and we registered using add_action. The first parameter customize_save_validation_before is the name of the hook, The second parameter weplugins_execute_on_customize_save_validation_before_event 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_action to remove customize_save_validation_before action.

Parameters

Below the 1 parameter is required to use this hook.

• $manager : (WP_Customize_Manager) WP_Customize_Manager instance.

Live Example 1: Basic Usage

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

    function weplugins_execute_on_customize_save_validation_before_event($manager){
        // You can write code here to be executed when this action occurs in WordPress. 
        // Use the parameters received in the function arguments & implement the required additional custom functionality according to your website requirements.
    }
    // add the action
    add_action( "customize_save_validation_before", "weplugins_execute_on_customize_save_validation_before_event" , 10, 1);
    

Live Example 2: Removing a Hook

To remove a hook callback, use the example below.

    remove_action( "customize_save_validation_before", "weplugins_execute_on_customize_save_validation_before_event", 10, 1 );
    

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

Live Example 3: Custom Validation Logic

In this example, we add custom validation logic to be executed before saving the customization settings.

    function weplugins_custom_validation($manager){
        // Custom validation code here
        if (/* some validation condition */){
            $manager->add_error('your_setting_id', __('Your custom error message', 'textdomain'));
        }
    }
    add_action( "customize_save_validation_before", "weplugins_custom_validation", 10, 1);
    

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