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



pre_clear_scheduled_hook › WordPress Filter Hooks

Since5.7.0
Deprecatedn/a
› apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args, $wp_error )
Parameters: (4)
  • (null|int|false|WP_Error) $pre Value to return instead. Default null to continue unscheduling 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 clearing a scheduled hook.

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) or false or a WP_Error if unscheduling one or more events fails.



Related Functions: wp_clear_scheduled_hook, wp_unschedule_hook, wp_next_scheduled, wp_get_schedule, wp_get_scheduled_event, _deprecated_hook


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

Source 

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