How to use customize_changeset_branching filter in WordPress

customize_changeset_branching filter

By default in core, when changeset branching is not allowed, changesets will operate linearly in that only one saved changeset will exist at a time (with a ‘draft’ or ‘future’ status). This makes the Customizer operate in a way that is similar to going to “edit” to one existing post: all users will be making changes to the same post, and autosave revisions will be made for that post.

To use customize_changeset_branching 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 Flipper Code, 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_branching_defaults which takes 2 parameters and we registered using add_filter. The first parameter customize_changeset_branching is name of the hook, The second parameter modify_customize_changeset_branching_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove customize_changeset_branching filter.

Parameters

Below are the 2 parameters are required to use this hook.

• $allow_branching : (bool) Whether branching is allowed. If false, the default, then only one saved changeset exists at a time.
• $wp_customize : (WP_Customize_Manager) Manager instance.

Live Example

apply_filters( 'customize_changeset_branching', bool $allow_branching, WP_Customize_Manager $wp_customize )

Below is an example how you can use this hook.

                        function modify_customize_changeset_branching_defaults($allow_branching, $wp_customize) { 
   
                            // Update the $allow_branching variable according to your website requirements and return this variable. You can modify the $allow_branching variable conditionally too if you want.

                            return $allow_branching; 
                        }
                        // add the filter
                        add_filter( "customize_changeset_branching", "modify_customize_changeset_branching_defaults", 10, 2 );

To remove a hook callback, use the example below.

remove_filter( "customize_changeset_branching", "modify_customize_changeset_branching_defaults", 10, 2 );

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

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.