wp_clear_scheduled_hook()

wp_clear_scheduled_hook() — 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 {

Inputs: $hook (string): Action hook, the execution of which will be unscheduled. $args (array): 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 must match those used when originally scheduling the event. If the arguments do not match exactly, the event will not be found. Default empty array. $wp_error (bool): 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.