Codex

Codex Resources

Function Reference/wp schedule event

Contents

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'); ?> 

Parameters

$timestamp
(integer) (required) The first time that you want the event to occur. This must be in a UNIX timestamp format.
Default: None
$recurrance
(string) (required) How often the event should reoccur. Valid values:
  • hourly
  • daily
Default: None
$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');
add_action('my_hourly_event', 'do_this_hourly');

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

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

Further Reading

For a comprehensive list of functions, take a look at the category Functions

Also, see Function_Reference

Retrieved from "http://codex.wordpress.org/Function_Reference/wp_schedule_event"