wp_schedule_event

Advertisement

Summery Summery

Schedules a recurring event.

Syntax Syntax

wp_schedule_event( int $timestamp, string $recurrence, string $hook, array $args = array() )

Description Description

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

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_single_event() to schedule a non-recurring event.

Parameters Parameters

$timestamp

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

$recurrence

(string) (Required) How often the event should subsequently recur. See wp_get_schedules() for accepted values.

$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()

Return Return

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

Source Source

File: wp-includes/cron.php


			

Advertisement

Changelog Changelog

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.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.