Filter hook 'pre_reschedule_event'

in WP Core File wp-includes/cron.php at line 402

View Source

pre_reschedule_event

Filter Hook
Description
Filter to override rescheduling of a recurring event. 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. }

Hook Information

File Location wp-includes/cron.php View on GitHub
Hook Type Filter
Line Number 402

Hook Parameters

Type Name Description
null|bool|WP_Error $pre Value to return instead. Default null to continue adding the event.
object $event { An object containing an event's data.
bool $wp_error Whether to return a WP_Error on failure.

Usage Examples

Basic Usage
<?php
// Hook into pre_reschedule_event
add_filter('pre_reschedule_event', 'my_custom_filter', 10, 3);

function my_custom_filter($pre, $event, $wp_error) {
    // Your custom filtering logic here
    return $pre;
}

Source Code Context

wp-includes/cron.php:402 - How this hook is used in WordPress core
<?php
 397  	 *     @type array  $args      Array containing each separate argument to pass to the hook's callback function.
 398  	 *     @type int    $interval  The interval time in seconds for the schedule.
 399  	 * }
 400  	 * @param bool               $wp_error Whether to return a WP_Error on failure.
 401  	 */
 402  	$pre = apply_filters( 'pre_reschedule_event', null, $event, $wp_error );
 403  
 404  	if ( null !== $pre ) {
 405  		if ( $wp_error && false === $pre ) {
 406  			return new WP_Error(
 407  				'pre_reschedule_event_false',

PHP Documentation

<?php
/**
	 * Filter to override rescheduling of a recurring event.
	 *
	 * 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.
	 *
	 * @since 5.1.0
	 * @since 5.7.0 The `$wp_error` parameter was added, and a `WP_Error` object can now be returned.
	 *
	 * @param null|bool|WP_Error $pre      Value to return instead. Default null to continue adding the event.
	 * @param object             $event    {
	 *     An object containing an event's data.
	 *
	 *     @type string $hook      Action hook to execute when the event is run.
	 *     @type int    $timestamp Unix timestamp (UTC) for when to next run the event.
	 *     @type string $schedule  How often the event should subsequently recur.
	 *     @type array  $args      Array containing each separate argument to pass to the hook's callback function.
	 *     @type int    $interval  The interval time in seconds for the schedule.
	 * }
	 * @param bool               $wp_error Whether to return a WP_Error on failure.
	 */
Quick Info
  • Hook Type: Filter
  • Parameters: 3
  • File: wp-includes/cron.php
Related Hooks

Related hooks will be displayed here in future updates.