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: - Introduced in WordPress: 2.1.0
- Deprecated in WordPress: —
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.