wp_schedule_single_event( int $timestamp, string $hook, array $args = array() )
Schedules an event to run only once.
Description
Schedules an event which will execute once by the ClassicPress actions core at a time which you specify. The action will fire off when someone visits your ClassicPress site, if the schedule 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.
Parameters
- $timestamp
-
(int) (Required) Unix timestamp (UTC) for when to run the event.
- $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_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 |
---|---|
WP-2.1.0 | Introduced. |