apply_filters( 'pre_reschedule_event', null|bool|WP_Error $pre, stdClass $event, bool $wp_error )

Filter to preflight or hijack rescheduling of events.

Description

Returning a non-null value will short-circuit the normal rescheduling process, causing the function to return the filtered value instead.

For plugins replacing wp-cron, return true if the event was successfully rescheduled, false if not.

Parameters

$pre

(null|bool|WP_Error) Value to return instead. Default null to continue adding the event.

$event

(stdClass) An object containing an event's data.

  • 'hook'
    (string) Action hook to execute when the event is run.
  • 'timestamp'
    (int) Unix timestamp (UTC) for when to next run the event.
  • 'schedule'
    (string|false) How often the event should subsequently recur.
  • 'args'
    (array) Array containing each separate argument to pass to the hook's callback function.
  • 'interval'
    (int) The interval time in seconds for the schedule. Only present for recurring events.

$wp_error

(bool) Whether to return a WP_Error on failure.

Source

File: wp-includes/cron.php

View on Trac

Changelog

Version Description
5.7.0 The $wp_error parameter was added, and a WP_Error object can now be returned.
5.1.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_reschedule_event