wp_schedule_event( int $timestamp, string $recurrence, string $hook, array $args = array() )
Schedule a recurring event.
Description
Schedules a hook which will be executed by the ClassicPress actions core on a specific interval, specified by you. The action will trigger when someone visits your ClassicPress 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().
Use wp_next_scheduled() to prevent duplicates
Parameters
- $timestamp
-
(int) (Required) Unix timestamp (UTC) for when to run the event.
- $recurrence
-
(string) (Required) How often the event should recur.
- $hook
-
(string) (Required) Action hook to execute when event is run.
- $args
-
(array) (Optional) Arguments to pass to the hook's callback function.
Default value: array()
Return
(false|void) False if the event does not get scheduled.
Source
File: wp-includes/cron.php
function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
// Make sure timestamp is a positive integer
if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
return false;
}
$crons = _get_cron_array();
$schedules = wp_get_schedules();
if ( !isset( $schedules[$recurrence] ) )
return false;
$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
/** This filter is documented in wp-includes/cron.php */
$event = apply_filters( 'schedule_event', $event );
// A plugin disallowed this event
if ( ! $event )
return false;
$key = md5(serialize($event->args));
$crons[$event->timestamp][$event->hook][$key] = array( 'schedule' => $event->schedule, 'args' => $event->args, 'interval' => $event->interval );
uksort( $crons, "strnatcasecmp" );
_set_cron_array( $crons );
}
Changelog
| Version | Description |
|---|---|
| WP-2.1.0 | Introduced. |