Skip to content

Commit

Permalink
Cron API: Add error logging and hooks to wp-cron.php.
Browse files Browse the repository at this point in the history
This changeset adds error logging on `wp_reschedule_event()` and `wp_unschedule_event` in `wp-cron.php`. This allows proper error logging when random errors appear. It also introduces `cron_reschedule_event_error` and `cron_unschedule_event_error` hooks which can be used to trigger additional behaviors when an error occurs.

Props Enchiridion, johnbillion, costdev.
Fixes #56048.


git-svn-id: https://develop.svn.wordpress.org/trunk@54258 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
audrasjb authored and = committed Nov 4, 2022
1 parent b684da9 commit 7ee2f97
Showing 1 changed file with 50 additions and 2 deletions.
52 changes: 50 additions & 2 deletions src/wp-cron.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,58 @@ function _get_cron_lock() {
$schedule = $v['schedule'];

if ( $schedule ) {
wp_reschedule_event( $timestamp, $schedule, $hook, $v['args'] );
$result = wp_reschedule_event( $timestamp, $schedule, $hook, $v['args'], true );

if ( is_wp_error( $result ) ) {
error_log(
sprintf(
/* translators: 1: Hook name, 2: Error code, 3: Error message, 4: Event data. */
__( 'Cron reschedule event error for hook: %1$s, Error code: %2$s, Error message: %3$s, Data: %4$s' ),
$hook,
$result->get_error_code(),
$result->get_error_message(),
wp_json_encode( $v )
)
);

/**
* Fires when an error happens rescheduling a cron event.
*
* @since 6.1.0
*
* @param WP_Error $result The WP_Error object.
* @param string $hook Action hook to execute when the event is run.
* @param array $v Event data.
*/
do_action( 'cron_reschedule_event_error', $result, $hook, $v );
}
}

wp_unschedule_event( $timestamp, $hook, $v['args'] );
$result = wp_unschedule_event( $timestamp, $hook, $v['args'], true );

if ( is_wp_error( $result ) ) {
error_log(
sprintf(
/* translators: 1: Hook name, 2: Error code, 3: Error message, 4: Event data. */
__( 'Cron unschedule event error for hook: %1$s, Error code: %2$s, Error message: %3$s, Data: %4$s' ),
$hook,
$result->get_error_code(),
$result->get_error_message(),
wp_json_encode( $v )
)
);

/**
* Fires when an error happens unscheduling a cron event.
*
* @since 6.1.0
*
* @param WP_Error $result The WP_Error object.
* @param string $hook Action hook to execute when the event is run.
* @param array $v Event data.
*/
do_action( 'cron_unschedule_event_error', $result, $hook, $v );
}

/**
* Fires scheduled events.
Expand Down

0 comments on commit 7ee2f97

Please sign in to comment.