Files
| Filename | Hook Type | Line Number | PHP Doc |
|---|---|---|---|
| wp-includes/cron.php | apply_filters | 570 | /** * Filter to preflight or hijack clearing a scheduled hook. * * 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. * * @since 5.1.0 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned. * * @param null|int|false|WP_Error $pre Value to return instead. Default null to continue unscheduling 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. */ |
Hook Parameters
| Parameter Type | Name | Description |
|---|---|---|
| null|int|false|WP_Error | $pre | Value to return instead. Default null to continue unscheduling the event. |
| string | $hook | Action hook, the execution of which will be unscheduled. |
| array | $args | Arguments to pass to the hook's callback function. |
| bool | $wp_error | Whether to return a WP_Error on failure. |