apply_filters( ‘pre_reschedule_event’, null|bool|WP_Error $pre, object $event, bool $wp_error )

Filter to override rescheduling of a recurring event.

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 or a WP_Error if not.

Parameters

$prenull|bool|WP_Error
Value to return instead. Default null to continue adding the event.
$eventobject
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
    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.
$wp_errorbool
Whether to return a WP_Error on failure.

Source

$pre = apply_filters( 'pre_reschedule_event', null, $event, $wp_error );

Changelog

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

User Contributed Notes

You must log in before being able to contribute a note or feedback.