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

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

$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.

Source

File: wp-includes/cron.php.

View all references

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

Leave a Reply

Your email address will not be published. Required fields are marked *