W3cubDocs

/WordPress

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

Retrieve the recurrence schedule for an event.

Description

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) False, if no schedule. Schedule name on success.

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

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

Uses

Uses	Description
wp-includes/cron.php: get_schedule	Filter the schedule for a hook.
wp-includes/cron.php: wp_get_scheduled_event()	Retrieve a scheduled event.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.

Changelog

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

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