How to use pre_schedule_event filter in WordPress

pre_schedule_event filter

Returning a non-null value will short-circuit adding the event to the cron array, causing the function to return the filtered value instead.

To use pre_schedule_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 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_pre_schedule_event_defaults which takes 3 parameters and we registered using add_filter. The first parameter pre_schedule_event is name of the hook, The second parameter modify_pre_schedule_event_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 pre_schedule_event filter.

Parameters

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

• $pre : (null|bool|WP_Error) Value to return instead. Default null to continue adding the event.
• $event : (stdClass) An object containing an event’s data.
  ‘hook’
  (string) Action hook to execute when the event is run.
  ‘timestamp’
  (int) Unix timestamp (UTC) for when to next run the event.
  ‘schedule’
  (string|false) How often the event should subsequently recur.
  ‘args’
  (array) Array containing each separate argument to pass to the hook’s callback function.
  ‘interval’
  (int) The interval time in seconds for the schedule. Only present for recurring events.
• $wp_error : (bool) Whether to return a WP_Error on failure.

Live Example

apply_filters( 'pre_schedule_event', null|bool|WP_Error $pre, stdClass $event, bool $wp_error )

Below is an example how you can use this hook.

                        function modify_pre_schedule_event_defaults($pre, $event, $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_schedule_event", "modify_pre_schedule_event_defaults", 10, 3 );

To remove a hook callback, use the example below.

remove_filter( "pre_schedule_event", "modify_pre_schedule_event_defaults", 10, 3 );

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.