Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: pre_unschedule_event

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
483       * @since 5.1.0
484       * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
485       *
486       * @param null|bool|WP_Error $pre       Value to return instead. Default null to continue unscheduling the event.
487       * @param int                $timestamp Timestamp for when to run the event.
488       * @param string             $hook      Action hook, the execution of which will be unscheduled.
489       * @param array              $args      Arguments to pass to the hook's callback function.
490       * @param bool               $wp_error  Whether to return a WP_Error on failure.
491       */
492      $pre = apply_filters( 'pre_unschedule_event', null, $timestamp, $hook, $args, $wp_error );
493
494      if ( null !== $pre ) {
495           if ( $wp_error && false === $pre ) {
496                return new WP_Error(
497                     'pre_unschedule_event_false',
498                     __( 'A plugin prevented the event from being unscheduled.' )
499                );
500           }
501