wppaste
WordPress

apply_filters( 'pre_unschedule_event', null|bool|WP_Error $pre, int $timestamp, string $hook, array $args, bool $wp_error )

Since
5.1.0, 5.7.0
Filter to override unscheduling of events.

Description

Returning a non-null value will short-circuit the normal unscheduling process, causing the function to return the filtered value instead.

For plugins replacing wp-cron, return true if the event was successfully unscheduled, false or a WP_Error if not.

Compatibility

WordPress
since 5.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$prenull|bool|WP_Error
Value to return instead. Default null to continue unscheduling the event.
$timestampint
Unix timestamp (UTC) for when to run the event.
$hookstring
Action hook, the execution of which will be unscheduled.
$argsarray
Arguments to pass to the hook's callback function.
$wp_errorbool
Whether to return a WP_Error on failure.

Where this hook fires · 1

  • wp-includes/cron.php:520wp_unschedule_event()

Source code

View on Trac View on GitHub 

<?php	 * @param null|bool|WP_Error $pre       Value to return instead. Default null to continue unscheduling the event.	 * @param int                $timestamp Unix timestamp (UTC) for when to run the event.	 * @param string             $hook      Action hook, the execution of which will be unscheduled.	 * @param array              $args      Arguments to pass to the hook's callback function.	 * @param bool               $wp_error  Whether to return a WP_Error on failure.	 */	$pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error ); 	if ( null !== $pre ) {		if ( $wp_error && false === $pre ) {			return new WP_Error(				'pre_unschedule_event_false',				__( 'A plugin prevented the event from being unscheduled.' )

Changelog

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

5.7.0
The $wp_error parameter was added, and a WP_Error object can now be returned.from the docblock
5.1.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, 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.