How to use pre_get_scheduled_event filter in WordPress

pre_get_scheduled_event filter

Returning a non-null value will short-circuit the normal process, returning the filtered value instead.

To use the pre_get_scheduled_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_get_scheduled_event_defaults which takes 4 parameters and we registered it using add_filter. The first parameter pre_get_scheduled_event is the name of the hook. The second parameter modify_pre_get_scheduled_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 the pre_get_scheduled_event filter.

Parameters

Below are the 4 parameters required to use this hook.

• $pre : (null|false|object) Value to return instead. Default null to continue retrieving the event.
• $hook : (string) Action hook of the event.
• $args : (array) Array containing each separate argument to pass to the hook’s callback function. Although not passed to a callback, these arguments are used to uniquely identify the event.
• $timestamp : (int|null) Unix timestamp (UTC) of the event. Null to retrieve the next scheduled event.

Live Example 1: Basic Usage

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

    function weplugins_modify_pre_get_scheduled_event_defaults($pre, $hook, $args, $timestamp) { 
        // 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_get_scheduled_event", "weplugins_modify_pre_get_scheduled_event_defaults", 10, 4 );
    

Live Example 2: Conditional Modification

In this example, we modify the pre value based on some condition.

    function weplugins_conditional_pre_get_scheduled_event($pre, $hook, $args, $timestamp) { 
        if ($hook == 'specific_hook') {
            $pre = false; // conditionally modify $pre
        }
        return $pre; 
    }
    add_filter( "pre_get_scheduled_event", "weplugins_conditional_pre_get_scheduled_event", 10, 4 );
    

Live Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter( "pre_get_scheduled_event", "weplugins_modify_pre_get_scheduled_event_defaults", 10, 4 );
    

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

Contact Us

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