説明
bool wp_schedule_event( int $timestamp, string $recurrence, string $hook [ , array $args = array() ] )
繰り返し実行するアクションをスケジュールに登録する。
パラメータ
- $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' ); ?>
フィルター
[5.1.0]次のスケジュールと比較する前に'pre_schedule_event'フィルターを呼び出す。パラメータ$preにはnullが、$eventにはhook、timestamp、schedule、args、intervalプロパティを持つイベント情報オブジェクトが格納されている。このフィルターでnull以外を返すとイベント情報は追加されない。$pre = apply_filters( 'pre_schedule_event', $pre, $event );$event = apply_filters( 'schedule_event', $event );アクション
直接実行するアクションはありません。ソースファイル
/wp-includes/cron.php最終更新 : 2019年03月20日 16:49
関連
お勧め
3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する（2014年1月17日 更新）
ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。
プラグインのロード順を制御する（2014年6月9日 更新）
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日 更新）
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。