How to use pre_unschedule_event filter in WordPress

pre_unschedule_event filter

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

To use pre_unschedule_event 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_pre_unschedule_event_defaults which takes 5 parameters and we registered using add_filter. The first parameter pre_unschedule_event is the name of the hook, The second parameter modify_pre_unschedule_event_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 pre_unschedule_event filter.

Parameters

Below are the 5 parameters required to use this hook.

• $pre : (null|bool|WP_Error) Value to return instead. Default null to continue unscheduling the event.
• $timestamp : (int) Timestamp for when to run the event.
• $hook : (string) Action hook, the execution of which will be unscheduled.
• $args : (array) Arguments to pass to the hook’s callback function.
• $wp_error : (bool) Whether to return a WP_Error on failure.

Live Examples

Example 1: Basic Usage

Below is an example of how you can use this hook to modify the $pre variable based on your website’s requirements.

    function weplugins_modify_pre_unschedule_event_defaults($pre, $timestamp, $hook, $args, $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_event", "weplugins_modify_pre_unschedule_event_defaults", 10, 5 );
    

Example 2: Conditional Modification

In this example, we will conditionally modify the $pre variable only if a specific hook is being unscheduled.

    function weplugins_conditional_pre_unschedule_event($pre, $timestamp, $hook, $args, $wp_error) {
        if ($hook == 'specific_hook_to_check') {
            $pre = true; // or any other modification
        }
        return $pre;
    }
    // add the filter
    add_filter( "pre_unschedule_event", "weplugins_conditional_pre_unschedule_event", 10, 5 );
    

Example 3: Removing a Hook Callback

To remove a hook callback, use the example below. Make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

    // remove the filter
    remove_filter( "pre_unschedule_event", "weplugins_modify_pre_unschedule_event_defaults", 10, 5 );
    

Contact Us

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