WP hooks navigation: Home/browse • Actions index • Filters index
To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).
The best way to understand what a hook does is to look at where it occurs in the source code.
do_action( "hook_name" )apply_filters( "hook_name", "what_to_filter" ).Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.
| Line | Code |
|---|---|
| 563 | * |
| 564 | * @since 5.1.0 |
| 565 | * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned. |
| 566 | * |
| 567 | * @param null|int|false|WP_Error $pre Value to return instead. Default null to continue unscheduling the event. |
| 568 | * @param string $hook Action hook, the execution of which will be unscheduled. |
| 569 | * @param array $args Arguments to pass to the hook's callback function. |
| 570 | * @param bool $wp_error Whether to return a WP_Error on failure. |
| 571 | */ |
| 572 | $pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args, $wp_error ); |
| 573 | |
| 574 | if ( null !== $pre ) { |
| 575 | if ( $wp_error && false === $pre ) { |
| 576 | return new WP_Error( |
| 577 | 'pre_clear_scheduled_hook_false', |
| 578 | __( 'A plugin prevented the hook from being cleared.' ) |
| 579 | ); |
| 580 | } |
| 581 | |