wp_clear_scheduled_hook


wp_clear_scheduled_hook ( $hook, $args = array(), $wp_error = false )

Parameters:
  • (string) hook Action hook, the execution of which will be unscheduled.
  • (array) args Optional. Array containing each separate argument to pass to the hook's callback function. Although not passed to a callback, these arguments are used to uniquely identify the event, so they should be the same as those used when originally scheduling the event. Default empty array.
  • (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 with the hook and arguments combination), false or WP_Error if unscheduling one or more events fail.
Defined at:
Change Log:
  • 5: .
  • 5: .

Description

Unschedules all events attached to the hook with the specified arguments.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_unschedule_hook, wp_next_scheduled, wp_get_schedule, wp_get_scheduled_event, wp_get_schedules

Top Google Results

User discussions

wpseek mobile