How to use automatic_updates_is_vcs_checkout filter in WordPress

automatic_updates_is_vcs_checkout filter

Filters whether the automatic updater should consider a filesystem location to be potentially managed by a version control system.

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

Parameters

Below are the 2 parameters required to use this hook.

• $checkout : (bool) Whether a VCS checkout was discovered at $context or ABSPATH, or anywhere higher.
• $context : (string) The filesystem context (a path) against which filesystem status should be checked.

Live Example 1

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

    function weplugins_modify_automatic_updates_is_vcs_checkout_defaults($checkout, $context) { 
        // Update the $checkout variable according to your website requirements and return this variable.
        return $checkout; 
    }
    // Add the filter
    add_filter("automatic_updates_is_vcs_checkout", "weplugins_modify_automatic_updates_is_vcs_checkout_defaults", 10, 2);
    

Live Example 2

To remove a hook callback, use the example below.

    remove_filter("automatic_updates_is_vcs_checkout", "weplugins_modify_automatic_updates_is_vcs_checkout_defaults", 10, 2);
    

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

Live Example 3

Another example could be conditionally modifying the $checkout value based on your custom logic.

    function weplugins_modify_automatic_updates_is_vcs_checkout_custom($checkout, $context) {
        if ($context === '/some/specific/path') {
            $checkout = true; // or false based on your needs
        }
        return $checkout;
    }
    // Add the filter with custom logic
    add_filter("automatic_updates_is_vcs_checkout", "weplugins_modify_automatic_updates_is_vcs_checkout_custom", 10, 2);
    

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.