How to use pre_unschedule_hook filter in WordPress

pre_unschedule_hook filter

Returning a non-null value will short-circuit the normal unscheduling process, causing the function to return the filtered value instead.

To use the pre_unschedule_hook filter, you first need to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

At WePlugins, we 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_modify_pre_unschedule_hook_defaults which takes 3 parameters and we registered it using add_filter. The first parameter pre_unschedule_hook is the name of the hook, the second parameter weplugins_modify_pre_unschedule_hook_defaults is the name of the function 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 the pre_unschedule_hook filter.

Parameters

Below are the 3 parameters required to use this hook.

• $pre : (null|int|false|WP_Error) Value to return instead. Default null to continue unscheduling the hook.
• $hook : (string) Action hook, the execution of which will be unscheduled.
• $wp_error : (bool) Whether to return a WP_Error on failure.

Live Examples

Example 1: Basic Hook Usage

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

    function weplugins_modify_pre_unschedule_hook_defaults($pre, $hook, $wp_error) {
        // Update the $pre variable according to your website requirements and return this variable. You can modify the $pre variable conditionally too if you want.
        return $pre;
    }
    // Add the filter
    add_filter("pre_unschedule_hook", "weplugins_modify_pre_unschedule_hook_defaults", 10, 3);
    

Example 2: Removing the Hook Callback

To remove a hook callback, use the example below.

    remove_filter("pre_unschedule_hook", "weplugins_modify_pre_unschedule_hook_defaults", 10, 3);
    

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

Example 3: Conditional Hook Modification

In this example, we modify the $pre variable conditionally.

    function weplugins_modify_pre_unschedule_hook_conditionally($pre, $hook, $wp_error) {
        if ($hook === 'specific_hook_name') {
            $pre = true; // Modify the $pre value based on a specific condition
        }
        return $pre;
    }
    // Add the filter
    add_filter("pre_unschedule_hook", "weplugins_modify_pre_unschedule_hook_conditionally", 10, 3);
    

Contact Us

If you need customization or assistance, please contact us.