wp_schedule_single_event( int $timestamp, string $hook, array $args = array(), bool $wp_error = false ): bool|WP_Error

39function wp_schedule_single_event( $timestamp, $hook, $args = array(), $wp_error = false ) {40	// Make sure timestamp is a positive integer.41	if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {42		if ( $wp_error ) {43			return new WP_Error(44				'invalid_timestamp',45				__( 'Event timestamp must be a valid Unix timestamp.' )46			);47		}48 49		return false;50	}51 52	$event = (object) array(53		'hook'      => $hook,54		'timestamp' => $timestamp,55		'schedule'  => false,56		'args'      => $args,57	);58 59	/**60	 * Filter to override scheduling an event.61	 *62	 * Returning a non-null value will short-circuit adding the event to the63	 * cron array, causing the function to return the filtered value instead.64	 *65	 * Both single events and recurring events are passed through this filter;66	 * single events have `$event->schedule` as false, whereas recurring events67	 * have this set to a recurrence from wp_get_schedules(). Recurring68	 * events also have the integer recurrence interval set as `$event->interval`.69	 *70	 * For plugins replacing wp-cron, it is recommended you check for an71	 * identical event within ten minutes and apply the {@see 'schedule_event'}72	 * filter to check if another plugin has disallowed the event before scheduling.73	 *74	 * Return true if the event was scheduled, false or a WP_Error if not.75	 *76	 * @since 5.1.077	 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.78	 *79	 * @param null|bool|WP_Error $result   The value to return instead. Default null to continue adding the event.80	 * @param object             $event    {81	 *     An object containing an event's data.82	 *83	 *     @type string       $hook      Action hook to execute when the event is run.84	 *     @type int          $timestamp Unix timestamp (UTC) for when to next run the event.85	 *     @type string|false $schedule  How often the event should subsequently recur.86	 *     @type array        $args      Array containing each separate argument to pass to the hook's callback function.87	 *     @type int          $interval  Optional. The interval time in seconds for the schedule. Only present for recurring events.88	 * }89	 * @param bool               $wp_error Whether to return a WP_Error on failure.90	 */91	$pre = apply_filters( 'pre_schedule_event', null, $event, $wp_error );92 93	if ( null !== $pre ) {94		if ( $wp_error && false === $pre ) {95			return new WP_Error(96				'pre_schedule_event_false',97				__( 'A plugin prevented the event from being scheduled.' )98			);99		}100 101		if ( ! $wp_error && is_wp_error( $pre ) ) {102			return false;103		}104 105		return $pre;106	}107 108	/*109	 * Check for a duplicated event.110	 *111	 * Don't schedule an event if there's already an identical event112	 * within 10 minutes.113	 *114	 * When scheduling events within ten minutes of the current time,115	 * all past identical events are considered duplicates.116	 *117	 * When scheduling an event with a past timestamp (ie, before the118	 * current time) all events scheduled within the next ten minutes
When	Instructions	Calls it makes
always	8–10	none
always	15–17	`__()`
`$pre !== null && $pre !== false`	27	`apply_filters()`
`$pre !== null`	28–31	`apply_filters(), is_wp_error()`
`$pre !== null && $pre === false`	33	`apply_filters(), __(), hook()`
`$pre === null`	58–71	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time()`
`$pre === null`	60–73	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), time()`
`$pre === null`	64–77	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), apply_filters()`
`$pre === null`	65–78	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), __()`
`$pre === null`	66–79	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), time(), apply_filters()`
`$pre === null`	67–80	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), time(), __()`
`$pre === null`	71–84	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), apply_filters(), __()`
`$pre === null`	73–86	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), time(), apply_filters(), __()`
`$pre === null`	81–94	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), apply_filters(), uksort(), _set_cron_array()`
`$pre === null`	83–96	`apply_filters(), _get_cron_array(), serialize(), md5(), time(), time(), time(), apply_filters(), uksort(), _set_cron_array()`
PHP	Compiled	Executed	Branches	Notes
8.6-dev	150	8–96	19
8.5	150	8–96	19
8.4	150	8–96	19	2 fewer instructions than PHP 8.3
8.3	152	10–98	19
8.2	152	10–98	19
8.1	152	10–98	19
7.4	152	10–98	19