wp_next_scheduled() WordPress Function
The wp_next_scheduled() function is used to get the next scheduled time for a task to run. It takes two parameters: the task (identified by a hook name) and any arguments that need to be passed to the task.
wp_next_scheduled( string $hook, array $args = array() ) #
Retrieve the next timestamp for an event.
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
(int|false) The Unix timestamp of the next time the event will occur. False if the event doesn't exist.
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;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.1.0 | Introduced. |