pre_clear_scheduled_hook
Filter to override 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.
Использование
add_filter( 'pre_clear_scheduled_hook', 'wp_kama_pre_clear_scheduled_hook_filter', 10, 4 ); /** * Function for `pre_clear_scheduled_hook` filter-hook. * * @param null|int|false|WP_Error $pre Value to return instead. * @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. * * @return null|int|false|WP_Error */ function wp_kama_pre_clear_scheduled_hook_filter( $pre, $hook, $args, $wp_error ){ // filter... return $pre; }
- $pre(null|int|false|WP_Error)
- Value to return instead.
По умолчанию: null to continue unscheduling the event - $hook(строка)
- Action hook, the execution of which will be unscheduled.
- $args(массив)
- Arguments to pass to the hook's callback function.
- $wp_error(true|false)
- Whether to return a WP_Error on failure.
Список изменений
С версии 5.1.0 | Введена. |
С версии 5.7.0 | The $wp_error parameter was added, and a WP_Error object can now be returned. |
Где вызывается хук
pre_clear_scheduled_hook
wp-includes/cron.php 583
$pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args, $wp_error );