Function Reference/wp schedule event

Languages: English • 日本語中文(简体) • (Add your language)

1 Description
2 Usage
3 Parameters
4 Examples
- 4.1 Schedule an hourly event
5 See Also
6 Further Reading

Description

Schedules a hook which will be executed by the WordPress actions core on a specific interval, specified by you. The action will trigger when someone visits your WordPress site, if the scheduled time has passed. See the Plugin API for a list of hooks.

Usage

<?php wp_schedule_event(time(), 'hourly', 'my_schedule_hook', $args); ?>

Parameters

$timestamp

(integer) (required) The first time that you want the event to occur. This must be in a UNIX timestamp format. WP cron uses UTC/GMT time, not local time. Use time(), which is always GMT in WordPress.

Default: None

$recurrence

(string) (required) How often the event should reoccur. Valid values:

hourly
twicedaily
daily

Default: None

The recurrence must be in the return values from wp_get_schedules. Use the filter cron_schedules to add or change recurrences. Use wp_schedule_single_event for non-recurring events.

$hook

(string) (required) The name of an action hook to execute.

Default: None

$args

(array) (optional) Arguments to pass to the hook function(s).

Default: None

Examples

Schedule an hourly event

To schedule an hourly event in a plugin, call wp_schedule_event on activation (otherwise you will end up with a lot of scheduled events!):

register_activation_hook(__FILE__, 'my_activation');

function my_activation() {
    if (! wp_next_scheduled ( 'my_hourly_event' )) {
	wp_schedule_event(time(), 'hourly', 'my_hourly_event');
    }
}

add_action('my_hourly_event', 'do_this_hourly');

function do_this_hourly() {
	// do something every hour
}

Don't forget to clean the scheduler on deactivation:

register_deactivation_hook(__FILE__, 'my_deactivation');

function my_deactivation() {
	wp_clear_scheduled_hook('my_hourly_event');
}

WordPress.org

Codex