How to use customize_changeset_save_data filter in WordPress

customize_changeset_save_data filter

Plugins may amend additional data (such as additional meta for settings) into the changeset with this filter.

To use customize_changeset_save_data 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_changeset_save_data_defaults which takes 2 parameters and we registered using add_filter. The first parameter customize_changeset_save_data is the name of the hook, The second parameter modify_customize_changeset_save_data_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_changeset_save_data filter.

Parameters

Below are the 2 parameters required to use this hook.

• $data: (array) Updated changeset data, mapping setting IDs to arrays containing a $value item and optionally other metadata.
• $context: (array) Filter context.
  • ‘uuid’ (string) Changeset UUID.
  • ‘title’ (string) Requested title for the changeset post.
  • ‘status’ (string) Requested status for the changeset post.
  • ‘date_gmt’ (string) Requested date for the changeset post in MySQL format and GMT timezone.
  • ‘post_id’ (int|false) Post ID for the changeset, or false if it doesn’t exist yet.
  • ‘previous_data’ (array) Previous data contained in the changeset.
  • ‘manager’ (WP_Customize_Manager) Manager instance.

Live Examples

Example 1: Basic Modification

Below is an example of how you can use this hook to modify changeset data.

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

Example 2: Conditional Modification

Here, we demonstrate how to conditionally modify the changeset data.

    function weplugins_modify_customize_changeset_save_data_conditional($data, $context) {
        if ($context['status'] === 'draft') {
            // Perform some action if the status is draft
            $data['new_meta'] = 'some_value';
        }
        return $data;
    }
    // add the filter
    add_filter( "customize_changeset_save_data", "weplugins_modify_customize_changeset_save_data_conditional", 10, 2 );
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    // remove the filter
    remove_filter( "customize_changeset_save_data", "weplugins_modify_customize_changeset_save_data_defaults", 10, 2 );
    

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

Contact Us

If you need any customization or have any trouble using this hook, please contact us and we’d be happy to assist you.