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

Retrieve the recurrence schedule for an event.

Description

See also

Parameters

$hook

(string) (Required) Action hook to identify the event.

$args

(array) (Optional) Arguments passed to the event's callback function.

Default value: array()

Return

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

Source

File: wp-includes/cron.php

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

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

	/**
	 * Filters the schedule 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 );
}

Changelog

Version Description
5.1.0 'get_schedule' filter added.
2.1.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_get_schedule