wp_schedule_single_event

SummerySummery

Schedules an event to run only once.

Syntax

wp_schedule_single_event( int $timestamp, string $hook, array $args = array() )

DescriptionDescription

Schedules a hook which will be triggered by WordPress at the specified 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.

ParametersParameters

$timestamp

(int) (Required) Unix timestamp (UTC) for when to next run the event.

$hook

(string) (Required) Action hook to execute when the event is run.

$args

(array) (Optional) Array containing each separate argument to pass to the hook's callback function.

Default value: array()

ReturnReturn

(bool) True if event successfully scheduled. False for failure.

SourceSource

File: wp-includes/cron.php


			

ChangelogChangelog

Changelog
Version Description
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.
Scroll to Top