* a time which you specify. The action will fire off when someone visits your
* WordPress site, if the schedule time has passed.
*
* a time which you specify. The action will fire off when someone visits your
* WordPress site, if the schedule time has passed.
*
- * @param int $timestamp Timestamp for when to run the event.
- * @param string $hook Action hook to execute when cron is run.
+ * @param int $timestamp Unix timestamp (UTC) for when to run the event.
+ * @param string $hook Action hook to execute when event is run.
- // don't schedule a duplicate if there's already an identical event due in the next 10 minutes
+ // Make sure timestamp is a positive integer
+ if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
+ return false;
+ }
+
+ // Don't schedule a duplicate if there's already an identical event due within 10 minutes of it
$crons = _get_cron_array();
$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
/**
$crons = _get_cron_array();
$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
/**
- * @param object $event An object containing an event's data.
+ * @param stdClass $event {
+ * An object containing an event's data.
+ *
+ * @type string $hook Action hook to execute when event is run.
+ * @type int $timestamp Unix timestamp (UTC) for when to run the event.
+ * @type string|false $schedule How often the event should recur. See `wp_get_schedules()`.
+ * @type array $args Arguments to pass to the hook's callback function.
+ * }
*
* Schedules a hook which will be executed by the WordPress actions core on a
* specific interval, specified by you. The action will trigger when someone
* visits your WordPress site, if the scheduled time has passed.
*
*
* Schedules a hook which will be executed by the WordPress actions core on a
* specific interval, specified by you. The action will trigger when someone
* visits your WordPress site, if the scheduled time has passed.
*
- * Valid values for the recurrence are hourly, daily and twicedaily. These can
- * be extended using the cron_schedules filter in wp_get_schedules().
+ * Valid values for the recurrence are hourly, daily, and twicedaily. These can
+ * be extended using the {@see 'cron_schedules'} filter in wp_get_schedules().
*/
function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
*/
function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
*/
function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
*/
function wp_reschedule_event( $timestamp, $recurrence, $hook, $args = array() ) {
$crons = _get_cron_array();
$schedules = wp_get_schedules();
$key = md5( serialize( $args ) );
$crons = _get_cron_array();
$schedules = wp_get_schedules();
$key = md5( serialize( $args ) );
* @param string $hook Action hook, the execution of which will be unscheduled.
* @param array $args 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.
* @param string $hook Action hook, the execution of which will be unscheduled.
* @param array $args 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.
$crons = _get_cron_array();
$key = md5(serialize($args));
unset( $crons[$timestamp][$hook][$key] );
$crons = _get_cron_array();
$key = md5(serialize($args));
unset( $crons[$timestamp][$hook][$key] );
*/
function wp_clear_scheduled_hook( $hook, $args = array() ) {
// Backward compatibility
// Previously this function took the arguments as discrete vars rather than an array like the rest of the API
if ( !is_array($args) ) {
*/
function wp_clear_scheduled_hook( $hook, $args = array() ) {
// Backward compatibility
// Previously this function took the arguments as discrete vars rather than an array like the rest of the API
if ( !is_array($args) ) {
- _deprecated_argument( __FUNCTION__, '3.0', __('This argument has changed to an array to match the behavior of the other cron functions.') );
+ _deprecated_argument( __FUNCTION__, '3.0.0', __('This argument has changed to an array to match the behavior of the other cron functions.') );
*/
function wp_next_scheduled( $hook, $args = array() ) {
$crons = _get_cron_array();
*/
function wp_next_scheduled( $hook, $args = array() ) {
$crons = _get_cron_array();
- * multiple processes on multiple web servers can run this code concurrently
- * try to make this as atomic as possible by setting doing_cron switch
- */
+ * Get the cron lock, which is a Unix timestamp of when the last cron was spawned
+ * and has not finished running.
+ *
+ * Multiple processes on multiple web servers can run this code concurrently,
+ * this lock attempts to make spawning as atomic as possible.
+ */
- if ( defined('ALTERNATE_WP_CRON') && ALTERNATE_WP_CRON ) {
- if ( !empty($_POST) || defined('DOING_AJAX') )
+ if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) {
+ if ( 'GET' !== $_SERVER['REQUEST_METHOD'] || defined( 'DOING_AJAX' ) || defined( 'XMLRPC_REQUEST' ) ) {
$doing_wp_cron = sprintf( '%.22F', $gmt_time );
set_transient( 'doing_cron', $doing_wp_cron );
$doing_wp_cron = sprintf( '%.22F', $gmt_time );
set_transient( 'doing_cron', $doing_wp_cron );
$doing_wp_cron = sprintf( '%.22F', $gmt_time );
set_transient( 'doing_cron', $doing_wp_cron );
/**
$doing_wp_cron = sprintf( '%.22F', $gmt_time );
set_transient( 'doing_cron', $doing_wp_cron );
/**
*/
$cron_request = apply_filters( 'cron_request', array(
'url' => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ),
*/
$cron_request = apply_filters( 'cron_request', array(
'url' => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ),
// Prevent infinite loops caused by lack of wp-cron.php
if ( strpos($_SERVER['REQUEST_URI'], '/wp-cron.php') !== false || ( defined('DISABLE_WP_CRON') && DISABLE_WP_CRON ) )
return;
// Prevent infinite loops caused by lack of wp-cron.php
if ( strpos($_SERVER['REQUEST_URI'], '/wp-cron.php') !== false || ( defined('DISABLE_WP_CRON') && DISABLE_WP_CRON ) )
return;
- * The supported recurrences are 'hourly' and 'daily'. A plugin may add more by
- * hooking into the 'cron_schedules' filter. The filter accepts an array of
- * arrays. The outer array has a key that is the name of the schedule or for
+ * The default supported recurrences are 'hourly', 'twicedaily', and 'daily'. A plugin may
+ * add more by hooking into the {@see 'cron_schedules'} filter. The filter accepts an array
+ * of arrays. The outer array has a key that is the name of the schedule or for
* example 'weekly'. The value is an array with two keys, one is 'interval' and
* the other is 'display'.
*
* example 'weekly'. The value is an array with two keys, one is 'interval' and
* the other is 'display'.
*
* 60*60*24*7 or 604800. The value of 'interval' would then be 604800.
*
* The 'display' is the description. For the 'weekly' key, the 'display' would
* 60*60*24*7 or 604800. The value of 'interval' would then be 604800.
*
* The 'display' is the description. For the 'weekly' key, the 'display' would
*
* For your plugin, you will be passed an array. you can easily add your
* schedule by doing the following.
*
* For your plugin, you will be passed an array. you can easily add your
* schedule by doing the following.
- * <code>
- * // filter parameter variable name is 'array'
- * $array['weekly'] = array(
- * 'interval' => 604800,
- * 'display' => __('Once Weekly')
- * );
- * </code>
+ *
+ * // Filter parameter variable name is 'array'.
+ * $array['weekly'] = array(
+ * 'interval' => 604800,
+ * 'display' => __( 'Once Weekly' )
+ * );
+ *
- * @param string $hook Action hook to execute when cron is run.
- * @param array $args Optional. Arguments to pass to the hook's callback function.
- * @return string|bool False, if no schedule. Schedule on success.
+ * @param string $hook Action hook to identify the event.
+ * @param array $args Optional. Arguments passed to the event's callback function.
+ * @return string|false False, if no schedule. Schedule name on success.
*/
function wp_get_schedule($hook, $args = array()) {
$crons = _get_cron_array();
*/
function wp_get_schedule($hook, $args = array()) {
$crons = _get_cron_array();