wp_unschedule_hook


wp_unschedule_hook ( $hook, $wp_error = false )

Parameters:
  • (string) hook Action hook, the execution of which will be unscheduled.
  • (bool) wp_error Optional. Whether to return a WP_Error on failure. Default false.
Returns:
  • (int|false|WP_Error) On success an integer indicating number of events unscheduled (0 indicates no events were registered on the hook), false or WP_Error if unscheduling fails.
Defined at:
Change Log:
  • 5: .
  • 5: .

Description

Unschedules all events attached to the hook.Can be useful for plugins when deactivating to clean up the cron queue. Warning: This function may return Boolean FALSE, but may also return a non-Boolean value which evaluates to FALSE. For information about casting to booleans see the {@link PHP documentation}. Use the `===` operator for testing the return value of this function.

Related Functions

wp_clear_scheduled_hook, wp_unschedule_event, wp_next_scheduled, wp_schedule_event, wp_get_schedule

Top Google Results

User discussions

wpseek mobile