Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: pre_clear_scheduled_hook

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

Line Code
561       *
562       * @since 5.1.0
563       * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
564       *
565       * @param null|int|false|WP_Error $pre      Value to return instead. Default null to continue unscheduling the event.
566       * @param string                  $hook     Action hook, the execution of which will be unscheduled.
567       * @param array                   $args     Arguments to pass to the hook's callback function.
568       * @param bool                    $wp_error Whether to return a WP_Error on failure.
569       */
570      $pre = apply_filters( 'pre_clear_scheduled_hook', null, $hook, $args, $wp_error );
571
572      if ( null !== $pre ) {
573           if ( $wp_error && false === $pre ) {
574                return new WP_Error(
575                     'pre_clear_scheduled_hook_false',
576                     __( 'A plugin prevented the hook from being cleared.' )
577                );
578           }
579