wp_unschedule_event

Unschedule a previously scheduled event.

Description

(false|void) wp_unschedule_event( (int) $timestamp, (string) $hook, (array) $args = array() ); 

The $timestamp and $hook parameters are required so that the event can be identified.

Returns (false|void)

False if the event does not get unscheduled.

Parameters (3)

0. $timestamp (int)
Unix timestamp (UTC) for when to run the event.
1. $hook (string)
Action hook, the execution of which will be unscheduled.
2. $args — Optional. (array) => array()
Arguments to pass to the hook's callback function. Although not passed to a callback function, these arguments are used to uniquely identify the scheduled event, so they should be the same as those used when originally scheduling the event.

Usage

  1. if ( !function_exists( 'wp_unschedule_event' ) ) { 
  2.     require_once ABSPATH . WPINC . '/cron.php'; 
  3. } 
  4.   
  5. // Unix timestamp (UTC) for when to run the event. 
  6. $timestamp = -1; 
  7.   
  8. // Action hook, the execution of which will be unscheduled. 
  9. $hook = ''; 
  10. $args = array(); 
  11.   
  12. // NOTICE! Understand what this does before running. 
  13. $result = wp_unschedule_event($timestamp, $hook, $args); 
  14.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/cron.php  
  1. function wp_unschedule_event( $timestamp, $hook, $args = array() ) { 
  2.     // Make sure timestamp is a positive integer 
  3.     if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) { 
  4.         return false; 
  5.     } 
  6.  
  7.     $crons = _get_cron_array(); 
  8.     $key = md5(serialize($args)); 
  9.     unset( $crons[$timestamp][$hook][$key] ); 
  10.     if ( empty($crons[$timestamp][$hook]) ) 
  11.         unset( $crons[$timestamp][$hook] ); 
  12.     if ( empty($crons[$timestamp]) ) 
  13.         unset( $crons[$timestamp] ); 
  14.     _set_cron_array( $crons ); 
  15. }