WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_get_schedule()

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

In this article

Back to top

Retrieves the name of the recurrence schedule for an event.

Description

See also

Parameters

$hookstringrequired
Action hook to identify the event.
$argsarrayoptional
Arguments passed to the event’s callback function.

Default:array()

Return

string|false Schedule name on success, false if no schedule.

Source

function wp_get_schedule( $hook, $args = array() ) {
	$schedule = false;
	$event    = wp_get_scheduled_event( $hook, $args );

	if ( $event ) {
		$schedule = $event->schedule;
	}

	/**
	 * Filters the schedule name for a hook.
	 *
	 * @since 5.1.0
	 *
	 * @param string|false $schedule Schedule for the hook. False if not found.
	 * @param string       $hook     Action hook to execute when cron is run.
	 * @param array        $args     Arguments to pass to the hook's callback function.
	 */
	return apply_filters( 'get_schedule', $schedule, $hook, $args );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_schedule’, string|false $schedule, string $hook, array $args )

Filters the schedule name for a hook.

UsesDescription
wp_get_scheduled_event()wp-includes/cron.php

Retrieves a scheduled event.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Changelog

VersionDescription
5.1.0'get_schedule' filter added.
2.1.0Introduced.

User Contributed Notes

  1. Skip to note 3 content
    Andrei G.
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    I suggest that maybe the documentation here should be updated to say that the function returns false if no RECURRENCE.

    I came across an issue lately with a plugin that was scheduling a single event and using wp_get_schedule() to check for the existence of a schedule. 

    if ( !wp_get_schedule( 'groups_file_access_session_delete_transients' )) {
			
			wp_schedule_single_event( time() + self::SCHEDULE, 'groups_file_access_session_delete_transients' );
		}

    It took me a while to understand that wp_get_schedule() does not return the actual timestamp like wp_next_scheduled() , but the recurrence value, if any (hourly, daily, etc.).

    As such, in the example above, the scheduling of single events was happening on every single call, causing for the cron field in the database to become gigantic.

    Since wp_get_schedule() seems to not see single events (since they have no recurrence) and will always return false for single events, it is somewhat confusing.

    I suspect people would expect for wp_get_schedule() to work like wp_next_scheduled() , but that’s not the case.

  2. Skip to note 4 content
    Codex
    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

    Basic Examples

    // If you previously added for example:
// wp_schedule_event( current_time( 'timestamp' ), 'hourly', 'my_hourly_event' );

$schedule = wp_get_schedule( 'my_hourly_event' );

// $schedule == 'hourly'

// Or this if you created something like this:
// wp_schedule_single_event( current_time( 'timestamp' ), 'hourly', 'my_hourly_event', array( 'some_arg' ) );

$schedule = wp_get_schedule( 'my_hourly_event', array( 'some_arg' ) );

// $schedule == 'hourly'

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