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

Retrieve the next timestamp for an event.

Contents

Description Description

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()

Top ↑

Return Return

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

Top ↑

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;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.1.0 Introduced.

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/class-wp-recovery-mode.php: WP_Recovery_Mode::initialize()

Initialize recovery mode for the current request.
wp-includes/functions.php: wp_schedule_delete_old_privacy_export_files()

Schedule a WP_Cron job to delete expired export files.
wp-admin/includes/post.php: get_default_post_to_edit()

Default post information to use when populating the “Write Post” form.
wp-includes/update.php: wp_schedule_update_checks()

Schedule core, theme, and plugin update checks.
wp-includes/update.php: wp_version_check()

Check WordPress version against the newest version.
wp-includes/post.php: _publish_post_hook()

Hook to schedule pings and enclosures when a post is published.
wp-includes/ms-functions.php: wp_schedule_update_network_counts()

Schedule update of the network-wide counts for the current network.
Show 2 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
    Contributed by ub3rst4r —

    Note the $args parameter! Not specifying the $args parameter in wp_next_scheduled but having $args for wp_schedule_event will cause many events to be scheduled (instead of just one).

    Bad Example:

    if ( ! wp_next_scheduled( 'myevent' ) ) { // This will always be false
	wp_schedule_event( time(), 'daily', 'myevent', array( false ) );
}

    Good Example:

    $args = array( false );
if ( ! wp_next_scheduled( 'myevent', $args ) ) {
	wp_schedule_event( time(), 'daily', 'myevent', $args );
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Kuba Mikita —

    Be careful when using arguments! WordPress doesn’t compare them 1:1 so you have to pay attention what type these are.

    It’s because WP generates a hash out of them: md5( serialize( $args ) )

    So when you have:

    wp_schedule_event( time(), 'daily', 'action_hook', array( 123 ) );

    And use a string because ie. the value was taken from the meta:

    wp_next_scheduled( 'action_hook', array( '123' ) );

    It will return false.

You must log in before being able to contribute a note or feedback.