How to use customize_save action in WordPress

customize_save action

Fires once the theme has switched in the Customizer, but before settings have been saved.

To use customize_save 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_event which takes 1 parameter and we registered using add_action. The first parameter customize_save is the name of the hook, the second parameter weplugins_execute_on_customize_save_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 action.

Parameters

Below the 1 parameter is required to use this hook.

• $manager: (WP_Customize_Manager) WP_Customize_Manager instance.

Live Example

do_action( 'customize_save', WP_Customize_Manager $manager )

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

    function weplugins_execute_on_customize_save_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", "weplugins_execute_on_customize_save_event" , 10, 1);
    

Example 1: Logging Customizer Save Event

This example logs a message to the debug log whenever the Customizer settings are saved.

    function weplugins_log_customizer_save($manager){
        if ( defined('WP_DEBUG') && WP_DEBUG ) {
            error_log('Customizer settings have been saved.');
        }
    }
    add_action( "customize_save", "weplugins_log_customizer_save" , 10, 1);
    

Example 2: Custom Notification on Save

This example sends an email notification to the site admin whenever the Customizer settings are saved.

    function weplugins_notify_admin_on_customize_save($manager){
        wp_mail(get_option('admin_email'), 'Customizer Saved', 'The Customizer settings have been saved.');
    }
    add_action( "customize_save", "weplugins_notify_admin_on_customize_save" , 10, 1);
    

Example 3: Cache Clear on Customizer Save

This example clears the website cache whenever the Customizer settings are saved.

    function weplugins_clear_cache_on_customize_save($manager){
        // Assuming there's a function clear_website_cache() available to clear cache
        clear_website_cache();
    }
    add_action( "customize_save", "weplugins_clear_cache_on_customize_save" , 10, 1);
    

To remove a hook callback, use the example below:

remove_action( "customize_save", "weplugins_execute_on_customize_save_event", 10, 1 );

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

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