WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

schedule_event

apply_filters( ‘schedule_event’, object|false $event )

In this article

Back to top

Modify an event before it is scheduled.

Parameters

$eventobject|false
An object containing an event’s data, or boolean false to prevent the event from being scheduled.
  • 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
    Optional. The interval time in seconds for the schedule. Only present for recurring events.

More Information

  • The hook is applied when a new event is added to the cron schedule. The hook passes through one parameter: the $event being scheduled.
  • In WordPress 3.21, the following recurring events are scheduled by the core: wp_version_check, wp_update_plugins, wp_update_themes, wp_schedule_delete, and (for the main site of multisite installs only) wp_update_network_counts.
  • In WordPress 3.21, the following single events are scheduled on demand by the core: publish_future_post, do_pings, importer_scheduled_cleanup.

Source

$event = apply_filters( 'schedule_event', $event );

View all references View on Trac View on GitHub

Used byDescription
wp_schedule_event()wp-includes/cron.php

Schedules a recurring event.

wp_schedule_single_event()wp-includes/cron.php

Schedules an event to run only once.

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Steven Lin
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Example migrated from Codex:

    Eliminates all checks for plugins

    add_filter( 'schedule_event', 'filter_cron_events', '10', 1);

function filter_cron_events($event) {
    switch ($event->hook) {
        case 'wp_version_check':
        case 'wp_update_plugins':
        case 'wp_update_themes':
        case 'wp_update_themes':
            $event = false;
        break;
    }
    return $event;
}

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