WordPress at a glance

wp_schedule_event() WP 1.0

Schedule a recurring event.

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.

Valid values for the recurrence are hourly, daily, and twicedaily. These can be extended using the 'cron_schedules' filter in wp_get_schedules().

Use wp_next_scheduled() to prevent duplicates

Hooks from function:
Return

false/null. False if the event does not get scheduled.

Usage

wp_schedule_event( $timestamp, $recurrence, $hook, $args );
$timestamp(int) (required)
Unix timestamp (UTC) for when to run the event.
$recurrence(string) (required)
How often the event should recur.
$hook(string) (required)
Action hook to execute when event is run.
$args(array)
Arguments to pass to the hook's callback function.
Default: array()

Code of wp_schedule_event: wp-includes/cron.php VER 4.9.8

<?php
function wp_schedule_event( $timestamp, $recurrence, $hook, $args = array()) {
	// Make sure timestamp is a positive integer
	if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {
		return false;
	}

	$crons = _get_cron_array();
	$schedules = wp_get_schedules();

	if ( !isset( $schedules[$recurrence] ) )
		return false;

	$event = (object) array( 'hook' => $hook, 'timestamp' => $timestamp, 'schedule' => $recurrence, 'args' => $args, 'interval' => $schedules[$recurrence]['interval'] );
	/** This filter is documented in wp-includes/cron.php */
	$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, 'interval' => $event->interval );
	uksort( $crons, "strnatcasecmp" );
	_set_cron_array( $crons );
}

Related Functions

From tag: cron (schedule)

No comments
    Hello, !     Log In . Register