wp_schedule_event ( $timestamp, $recurrence, $hook, $args = array(), $wp_error = false )

  • (int) timestamp Unix timestamp (UTC) for when to next run the event.
  • (string) recurrence How often the event should subsequently recur. See wp_get_schedules() for accepted values.
  • (string) hook Action hook to execute when the event is run.
  • (array) args Optional. Array containing arguments to pass to the hook's callback function. Each value in the array is passed to the callback as an individual parameter. The array keys are ignored. Default empty array.
  • (bool) wp_error Optional. Whether to return a WP_Error on failure. Default false.
  • (bool|WP_Error) True if event successfully scheduled. False or WP_Error on failure.
Defined at:
Change Log:
  • 5: .
  • 5: .


Schedules a recurring event.Schedules a hook which will be triggered by WordPress at the specified interval. The action will trigger when someone visits your WordPress site if the scheduled time has passed. Valid values for the recurrence are 'hourly', 'daily', and 'twicedaily'. These can be extended using the {@see 'cron_schedules'} filter in wp_get_schedules(). Note that scheduling an event to occur within 10 minutes of an existing event with the same action hook will be ignored unless you pass unique `$args` values for each scheduled event. Use wp_next_scheduled() to prevent duplicate events. Use wp_schedule_single_event() to schedule a non-recurring event.

Related Functions

wp_reschedule_event, wp_unschedule_event, wp_get_scheduled_event, wp_schedule_single_event, wp_scheduled_delete

Top Google Results

User discussions

wpseek mobile