How to use customize_refresh_nonces filter in WordPress

customize_refresh_nonces filter

Filters nonces for Customizer.

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

Parameters

Below are the 2 parameters required to use this hook.

• $nonces: (string[]) Array of refreshed nonces for save and preview actions.
• $manager: (WP_Customize_Manager) WP_Customize_Manager instance.

Live Example

apply_filters( 'customize_refresh_nonces', string[] $nonces, WP_Customize_Manager $manager )

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

function weplugins_modify_customize_refresh_nonces_defaults($nonces, $manager) { 
    // Update the $nonces variable according to your website requirements and return this variable. 
    // You can modify the $nonces variable conditionally too if you want.
    return $nonces; 
}
// Add the filter
add_filter( "customize_refresh_nonces", "weplugins_modify_customize_refresh_nonces_defaults", 10, 2 );

Example 1: Modify Nonces for Customizer

In this example, we are modifying the nonces for the customizer to suit specific requirements.

function weplugins_modify_customize_refresh_nonces_example1($nonces, $manager) { 
    // Custom logic to modify nonces
    return $nonces; 
}
// Add the filter
add_filter( "customize_refresh_nonces", "weplugins_modify_customize_refresh_nonces_example1", 10, 2 );

Example 2: Conditional Nonces Update

This example demonstrates how to update nonces conditionally based on certain conditions.

function weplugins_modify_customize_refresh_nonces_example2($nonces, $manager) {
    if ( /* some condition */ ) {
        // Modify nonces based on condition
    }
    return $nonces; 
}
// Add the filter
add_filter( "customize_refresh_nonces", "weplugins_modify_customize_refresh_nonces_example2", 10, 2 );

Example 3: Remove Hook Callback

To remove a hook callback, use the example below.

remove_filter( "customize_refresh_nonces", "weplugins_modify_customize_refresh_nonces_defaults", 10, 2 );

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 or need customization, please Contact Us and we’d be happy to assist you.