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 );

View all references View on Trac View on GitHub

Changelog