apply_filters( 'schedule_event', stdClass|false $event )

Modify an event before it is scheduled.


Parameters Parameters

$event

(stdClass|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) The interval time in seconds for the schedule. Only present for recurring events.


Top ↑

More Information 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.

Top ↑

Source Source

File: wp-includes/cron.php

View on Trac



Top ↑

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by stevenlinx

    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.