wp_schedule_single_event

パラメータ

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

返り値

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

注意

パラメータ$timestampの値はGMT時間になるので、日本時間との時差に注意しなければならない。

同じアクション名であっても、パラメータの内容が異なれば複数登録できる。また、同アクション名、同じ内容のパラメータについては、設定する実行時間が以前の実行時間から10分を超えている場合は登録できる（10分以内は登録できない）。

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

使用例

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

  <?php
  function delayed_action( $arg1 ) {
  	// ここにアクション内容を
  }
  add_action( 'schedule_delayed_action', 'delayed_action' );
  
  wp_schedule_single_event( time()+24*3600, 'schedule_delayed_action', array( 'hello world.' ) );
  ?>

フィルター

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

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

アクション

ソースファイル