apply_filters( 'pre_unschedule_event', null|bool|WP_Error $pre, int $timestamp, string $hook, array $args, bool $wp_error )

Filter to preflight or hijack unscheduling of events.


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

For plugins replacing wp-cron, return true if the event was successfully unscheduled, false if not.

Top ↑



(null|bool|WP_Error) Value to return instead. Default null to continue unscheduling the event.


(int) Timestamp for when to run the event.


(string) Action hook, the execution of which will be unscheduled.


(array) Arguments to pass to the hook's callback function.


(bool) Whether to return a WP_Error on failure.

Top ↑


File: wp-includes/cron.php

View on Trac

Top ↑


Version Description
5.7.0 The $wp_error parameter was added, and a WP_Error object can now be returned.
5.1.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.