wp_schedule_single_event( int $timestamp, string $hook, array $args = array(), bool $wp_error = false )
Schedules an event to run only once.
Description
Schedules a hook which will be triggered by WordPress at the specified UTC time.
The action will trigger when someone visits your WordPress site if the scheduled time has passed.
Note that scheduling an event to occur within 10 minutes of an existing event with the same action hook will be ignored unless you pass unique $args
values for each scheduled event.
Use wp_next_scheduled() to prevent duplicate events.
Use wp_schedule_event() to schedule a recurring event.
Parameters
- $timestamp
-
(Required) Unix timestamp (UTC) for when to next run the event.
- $hook
-
(Required) Action hook to execute when the event is run.
- $args
-
(Optional) Array containing arguments to pass to the hook's callback function. Each value in the array is passed to the callback as an individual parameter.<br> The array keys are ignored.
Default value: array()
- $wp_error
-
(Optional) Whether to return a WP_Error on failure.
Default value: false
Return
(bool|WP_Error) True if event successfully scheduled. False or WP_Error on failure.
Source
File: wp-includes/cron.php
function wp_schedule_single_event( $timestamp, $hook, $args = array()) {
// 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
$next = wp_next_scheduled($hook, $args);
if ( $next && abs( $next - $timestamp ) <= 10 * MINUTE_IN_SECONDS ) {
return false;
}
$crons = _get_cron_array();
$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => false, 'args' => $args );
/**
* Filters a single event before it is scheduled.
*
* @since WP-3.1.0
*
* @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.
* }
*/
$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 );
uksort( $crons, "strnatcasecmp" );
_set_cron_array( $crons );
}
Changelog
Version | Description |
---|---|
5.7.0 | The $wp_error parameter was added. |
5.1.0 | Return value modified to boolean indicating success or failure, 'pre_schedule_event' filter added to short-circuit the function. |
2.1.0 | Introduced. |