Filter to override clearing all events attached to the hook.

Description

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 the number of events successfully unscheduled (zero if no events were registered with the hook). If unscheduling one or more events fails then return either a WP_Error object or false depending on the value of the $wp_error parameter.

Parameters

$prenull|int|false|WP_Error

Value to return instead. Default null to continue unscheduling the hook.

$hookstring

Action hook, the execution of which will be unscheduled.

$wp_errorbool

Whether to return a WP_Error on failure.

Source

$pre = apply_filters( 'pre_unschedule_hook', null, $hook, $wp_error );

View all references View on Trac View on GitHub

Changelog