A WordPress-centric search engine for devs and theme authors



wp_get_schedule ›

Since2.1.0
Deprecatedn/a
wp_get_schedule ( $hook, $args = array() )
Parameters: (2)
  • (string) $hook Action hook to identify the event.
    Required: Yes
  • (array) $args Optional. Arguments passed to the event's callback function.
    Required: No
    Default: array()
See:
Returns:
  • (string|false) False, if no schedule. Schedule name on success.
Defined at:
Codex:
Change Log:
  • 5.0.0

Retrieve the recurrence schedule for an event.



Source

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.0.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 );
}