WordPress Hooks Explorer

Listing all hooks extracted WordPress Core


Details about pre_unschedule_event

Back to home

Files

Filename Hook Type Line Number PHP Doc
wp-includes/cron.php apply_filters 490 /**
* 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 or a WP_Error if not.
*
* @since 5.1.0
* @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
*
* @param null|bool|WP_Error $pre Value to return instead. Default null to continue unscheduling the event.
* @param int $timestamp Timestamp for when to run the event.
* @param string $hook Action hook, the execution of which will be unscheduled.
* @param array $args Arguments to pass to the hook's callback function.
* @param bool $wp_error Whether to return a WP_Error on failure.
*/

Hook Parameters

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