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

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$timestampint

Unix timestamp (UTC) of the event.

$hookstring

Action hook of the event.

$argsarrayoptional

Array containing each separate argument to pass to the hook's callback function.
Although not passed to a callback, these arguments are used to uniquely identify the event, so they should be the same as those used when originally scheduling the event.
Default empty array.Default: array()

$wp_errorbooloptional

Whether to return a WP_Error on failure. Default false.Default: false

Return value

bool|WP_Error

True if event successfully unscheduled. False or WP_Error on failure.

Performance profile

How much work a call to wp_unschedule_event() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–45

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 73.

Plugin surface

1 hook

Third-party callbacks on 'pre_unschedule_event' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• serializeserialisationserialize()called directly
• optionoption read or writeget_option()one call below wp_unschedule_event()

Further down the call graph this can also reach cache, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_unschedule_event() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_unschedule_event() runs, in this order:

1. 1
   apply_filters( pre_unschedule_event )filterline 493 (+31 into the body)

   Filter to override unscheduling of events.

Uses · 6

• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• _get_cron_array()Retrieves cron info array option.
• _set_cron_array()Updates the cron option with the new cron array.
• WP_Error::__construct()Initializes the error.

Used by · 1

• wp_clear_scheduled_hook()Unschedules all events attached to the hook with the specified arguments.

Source code

View on Trac ↗View on GitHub ↗

462function wp_unschedule_event( $timestamp, $hook, $args = array(), $wp_error = false ) {463	// Make sure timestamp is a positive integer.464	if ( ! is_numeric( $timestamp ) || $timestamp <= 0 ) {465		if ( $wp_error ) {466			return new WP_Error(467				'invalid_timestamp',468				__( 'Event timestamp must be a valid Unix timestamp.' )469			);470		}471 472		return false;473	}474 475	/**476	 * Filter to override unscheduling of events.477	 *478	 * Returning a non-null value will short-circuit the normal unscheduling479	 * process, causing the function to return the filtered value instead.480	 *481	 * For plugins replacing wp-cron, return true if the event was successfully482	 * unscheduled, false or a WP_Error if not.483	 *484	 * @since 5.1.0485	 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.486	 *487	 * @param null|bool|WP_Error $pre       Value to return instead. Default null to continue unscheduling the event.488	 * @param int                $timestamp Unix timestamp (UTC) for when to run the event.489	 * @param string             $hook      Action hook, the execution of which will be unscheduled.490	 * @param array              $args      Arguments to pass to the hook's callback function.491	 * @param bool               $wp_error  Whether to return a WP_Error on failure.492	 */493	$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );494 495	if ( null !== $pre ) {496		if ( $wp_error && false === $pre ) {497			return new WP_Error(498				'pre_unschedule_event_false',499				__( 'A plugin prevented the event from being unscheduled.' )500			);501		}502 503		if ( ! $wp_error && is_wp_error( $pre ) ) {504			return false;505		}506 507		return $pre;508	}509 510	$crons = _get_cron_array();511	$key   = md5( serialize( $args ) );512 513	unset( $crons[ $timestamp ][ $hook ][ $key ] );514 515	if ( empty( $crons[ $timestamp ][ $hook ] ) ) {516		unset( $crons[ $timestamp ][ $hook ] );517	}518 519	if ( empty( $crons[ $timestamp ] ) ) {520		unset( $crons[ $timestamp ] );521	}522 523	return _set_cron_array( $crons, $wp_error );524}

Changelog

Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/cron.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.