Files
Filename | Hook Type | Line Number | PHP Doc |
---|---|---|---|
wp-includes/cron.php | apply_filters | 399 | /** * Filter to preflight or hijack 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 stdClass $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. */ |
Hook Parameters
Parameter Type | Name | Description |
---|---|---|
null|bool|WP_Error | $pre | Value to return instead. Default null to continue adding the event. |
stdClass | $even | t { |
bool | $wp_error | Whether to return a WP_Error on failure. |