How to use customize_preview_this-type action in WordPress

customize_preview_this-type action

The dynamic portion of the hook name, `$this->type`, refers to the setting type.

To use `customize_preview_this-type` 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_preview_this-type_event` which takes 1 parameter and we registered using `add_action`. The first parameter `customize_preview_this-type` is the name of the hook, the second parameter `weplugins_execute_on_customize_preview_this-type_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_preview_this-type` action.

Parameters

Below the 1 parameter is required to use this hook.

• $setting: (WP_Customize_Setting) WP_Customize_Setting instance.

Live Example

do_action( "customize_preview_{$this->type}", WP_Customize_Setting $setting )

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

Example 1: Adding the Hook

This example demonstrates how to add the `customize_preview_this-type` action.

function weplugins_execute_on_customize_preview_this_type_event($setting){
   // You can write code here to be executed when this action occurs in WordPress.
}

// add the action
add_action( "customize_preview_this-type", "weplugins_execute_on_customize_preview_this_type_event" , 10, 1);

Example 2: Removing the Hook

To remove a hook callback, use the example below.

remove_action( "customize_preview_this-type", "weplugins_execute_on_customize_preview_this_type_event", 10, 1 );

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

Example 3: Modifying the Hook

This example demonstrates how to modify the hook to perform a different action.

function weplugins_modified_customize_preview_this-type_event($setting){
   // New functionality to be added here.
}

// modify the action
remove_action( "customize_preview_this-type", "weplugins_execute_on_customize_preview_this_type_event", 10, 1 );
add_action( "customize_preview_this-type", "weplugins_modified_customize_preview_this_type_event" , 10, 1);

Contact Us

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