wpseek.com
A WordPress-centric search engine for devs and theme authors



pre_unschedule_event › WordPress Filter Hooks

Since5.7.0
Deprecatedn/a
› apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error )
Parameters: (5)
  • (null|bool|WP_Error) $pre Value to return instead. Default null to continue unscheduling the event.
    Required: Yes
  • (int) $timestamp Timestamp for when to run the event.
    Required: Yes
  • (string) $hook Action hook, the execution of which will be unscheduled.
    Required: Yes
  • (array) $args Arguments to pass to the hook's callback function.
    Required: Yes
  • (bool) $wp_error Whether to return a WP_Error on failure.
    Required: Yes
Defined at:
Codex:

Filter to override 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.



Related Functions: wp_unschedule_event, wp_reschedule_event, wp_schedule_event, wp_get_scheduled_event, wp_schedule_single_event, wp_scheduled_delete


Related Hooks: pre_schedule_event, pre_reschedule_event, pre_get_scheduled_event, schedule_event, pre_unschedule_hook

Source 

$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );