wp_schedule_event

パラメータ

• $timestamp
  実行時間（GMT時刻）を指定。
• $recurrence
  'hourly'、'twicedaily'、'daily'などを指定。
• $hook
  アクション名を指定。
• $args
  スケジュールのパラメータを配列で指定（省略時はarray()）。

返り値

アクションをスケジュールに追加した場合はtrueを、追加しなかった場合はfalseを返す。

注意

パラメータ$timestampの値はGMT時間になるので、日本時間との時差に注意しなければならない。また$recurrenceの値は、任意ではなく、 wp_get_schedules関数で取得できる連想配列のキーのいずれかでなければならない。

[5.1.0]スケジュールを登録できた場合にtrueを返すようになった（以前は何も返さない）。

各フィルターは wp_schedule_single_event関数と共通する。どちらの関数のフィルターなのかは、パラメータ$eventのscheduleプロパティの内容とintervalプロパティの有無で判定できる。

使用例

• アクション名'schedule_daily_action'のアクションを登録する。

  <?php
  function daily_action() {
  	// ここにアクション内容を
  }
  add_action( 'schedule_daily_action', 'daily_action' );
  
  wp_schedule_event( strtotime( 'tomorrow' ), 'daily', 'schedule_daily_action' );
  ?>

フィルター

$pre = apply_filters( 'pre_schedule_event', $pre, $event );

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

アクション

ソースファイル