wp_get_schedule

Retrieve the recurrence schedule for an event.

Description

(string|false) wp_get_schedule( (string) $hook, (array) $args = array() ); 

Returns (string|false)

False, if no schedule. Schedule name on success.

Parameters (2)

0. $hook (string)
Action hook to identify the event.
1. $args — Optional. (array) => array()
Arguments passed to the event's callback function.

Usage

  1. if ( !function_exists( 'wp_get_schedule' ) ) { 
  2.     require_once ABSPATH . WPINC . '/cron.php'; 
  3. } 
  4.   
  5. // Action hook to identify the event. 
  6. $hook = ''; 
  7.   
  8. // Optional. Arguments passed to the event's callback function. 
  9. $args = array(); 
  10.   
  11. // NOTICE! Understand what this does before running. 
  12. $result = wp_get_schedule($hook, $args); 
  13.     

Defined (1)

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

/wp-includes/cron.php  
  1. function wp_get_schedule($hook, $args = array()) { 
  2.     $crons = _get_cron_array(); 
  3.     $key = md5(serialize($args)); 
  4.     if ( empty($crons) ) 
  5.         return false; 
  6.     foreach ( $crons as $timestamp => $cron ) { 
  7.         if ( isset( $cron[$hook][$key] ) ) 
  8.             return $cron[$hook][$key]['schedule']; 
  9.     } 
  10.     return false; 
  11. }