wp_next_scheduled( string $hook, array $args = array() ): int|false

Parameters

$hookstring

Action hook of the event.

$argsarrayoptional

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 empty array.Default: array()

Return

int|false

The Unix timestamp of the next time the event will occur. False if the event doesn't exist.

Uses · 1

• wp_get_scheduled_event()Retrieves a scheduled event.

Used by · 13

• WP_Recovery_Mode::initialize()Initialize recovery mode for the current request.
• WP_Site_Health::maybe_create_scheduled_event()Creates a weekly cron event, if one does not already exist.
• WP_Upgrader::schedule_temp_backup_cleanup()Schedules the cleanup of the temporary backup directory.
• _publish_post_hook()Hook to schedule pings and enclosures when a post is published.
• _wp_check_for_scheduled_split_terms()In order to avoid the _wp_batch_split_terms() job being accidentally removed, checks that it's still scheduled while we haven't finished splitting terms.
• _wp_check_for_scheduled_update_comment_type()In order to avoid the _wp_batch_update_comment_type() job being accidentally removed, check that it's still scheduled while we haven't finished updating comment types.
• get_default_post_to_edit()Returns default post information to use when populating the "Write Post" form.
• wp_get_auto_update_message()Determines the appropriate auto-update message to be displayed.
• wp_schedule_delete_old_privacy_export_files()Schedules a `WP_Cron` job to delete expired export files.
• wp_schedule_update_checks()Schedules core, theme, and plugin update checks.
• wp_schedule_update_network_counts()Schedules update of the network-wide counts for the current network.
• wp_schedule_update_user_counts()Schedules a recurring recalculation of the total count of users.

Source

View on Trac ↗View on GitHub ↗

832function wp_next_scheduled( $hook, $args = array() ) {833	$next_event = wp_get_scheduled_event( $hook, $args );834 835	if ( ! $next_event ) {836		return false;837	}838 839	return $next_event->timestamp;840}

History

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/cron.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.