apply_filters( ‘pre_clear_scheduled_hook’, null|int|false|WP_Error $pre, string $hook, array $args, bool $wp_error )

Filter to override clearing a scheduled hook.

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 the number of events successfully unscheduled (zero if no events were registered with the hook) or false or a WP_Error if unscheduling one or more events fails.

Parameters

$prenull|int|false|WP_Error
Value to return instead. Default null to continue unscheduling 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.

Source

$pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args, $wp_error );

Changelog

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

User Contributed Notes

You must log in before being able to contribute a note or feedback.