wp_unschedule_hook( string $hook, bool $wp_error = false ): int|false|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

$hookstring

Action hook, the execution of which will be unscheduled.

$wp_errorbooloptional

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

Return value

int|false|WP_Error

On success an integer indicating number of events unscheduled (0 indicates no events were registered on the hook), false or WP_Error if unscheduling fails.

Performance profile

How much work a call to wp_unschedule_hook() 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

Heavy

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

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

16–33

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

Plugin surface

1 hook

Third-party callbacks on 'pre_unschedule_hook' 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
• optionoption read or writeget_option()one call below wp_unschedule_hook()

Further down the call graph this can also reach cache, serialize, 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_hook() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( pre_unschedule_hook )filterline 673 (+19 into the body)

   Filter to override clearing all events attached to the hook.

Uses · 6

• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• 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_install()Installs the site.

Source code

View on Trac ↗View on GitHub ↗

654function wp_unschedule_hook( $hook, $wp_error = false ) {655	/**656	 * Filter to override clearing all events attached to the hook.657	 *658	 * Returning a non-null value will short-circuit the normal unscheduling659	 * process, causing the function to return the filtered value instead.660	 *661	 * For plugins replacing wp-cron, return the number of events successfully662	 * unscheduled (zero if no events were registered with the hook). If unscheduling663	 * one or more events fails then return either a WP_Error object or false depending664	 * on the value of the `$wp_error` parameter.665	 *666	 * @since 5.1.0667	 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.668	 *669	 * @param null|int|false|WP_Error $pre      Value to return instead. Default null to continue unscheduling the hook.670	 * @param string                  $hook     Action hook, the execution of which will be unscheduled.671	 * @param bool                    $wp_error Whether to return a WP_Error on failure.672	 */673	$pre = apply_filters( 'pre_unschedule_hook', null, $hook, $wp_error );674 675	if ( null !== $pre ) {676		if ( $wp_error && false === $pre ) {677			return new WP_Error(678				'pre_unschedule_hook_false',679				__( 'A plugin prevented the hook from being cleared.' )680			);681		}682 683		if ( ! $wp_error && is_wp_error( $pre ) ) {684			return false;685		}686 687		return $pre;688	}689 690	$crons = _get_cron_array();691	if ( empty( $crons ) ) {692		return 0;693	}694 695	$results = array();696 697	foreach ( $crons as $timestamp => $args ) {698		if ( ! empty( $crons[ $timestamp ][ $hook ] ) ) {699			$results[] = count( $crons[ $timestamp ][ $hook ] );700		}701 702		unset( $crons[ $timestamp ][ $hook ] );703 704		if ( empty( $crons[ $timestamp ] ) ) {705			unset( $crons[ $timestamp ] );706		}707	}708 709	/*710	 * If the results are empty (zero events to unschedule), no attempt711	 * to update the cron array is required.712	 */713	if ( empty( $results ) ) {714		return 0;715	}716 717	$set = _set_cron_array( $crons, $wp_error );718 719	if ( true === $set ) {720		return array_sum( $results );721	}722 723	return $set;724}

Changelog

Introduced in 4.9.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.