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

Filter to preflight or hijack clearing a scheduled hook.


Description 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 if unscheduling one or more events fails.


Top ↑

Parameters Parameters

$pre

(null|int|false|WP_Error) Value to return instead. Default null to continue unscheduling the event.

$hook

(string) Action hook, the execution of which will be unscheduled.

$args

(array) Arguments to pass to the hook's callback function.

$wp_error

(bool) Whether to return a WP_Error on failure.


Top ↑

Source Source

File: wp-includes/cron.php

View on Trac



Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

Top ↑

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