wp_next_scheduled

Advertisement

Summery Summery

Retrieve the next timestamp for an event.

Syntax Syntax

wp_next_scheduled( string $hook, array $args = array() )

Parameters Parameters

$hook

(string) (Required) Action hook of the event.

$args

(array) (Optional) Array containing each separate argument to pass to the hook's callback function. Although not passed to a callback, these arguments are used to uniquely identify the event, so they should be the same as those used when originally scheduling the event.

Default value: array()

Return Return

(int|false) The Unix timestamp of the next time the event will occur. False if the event doesn't exist.

Source Source

File: wp-includes/cron.php

function wp_next_scheduled( $hook, $args = array() ) {
	$next_event = wp_get_scheduled_event( $hook, $args );
	if ( ! $next_event ) {
		return false;
	}

	return $next_event->timestamp;
}

Advertisement

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Advertisement

Leave a Reply

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