wp_schedule_event

説明

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 );
[3.1.0]アクションの登録前に'schedule_event'フィルターを呼び出す。パラメータ$eventにはイベント情報オブジェクトが格納されている。フィルター関数でfalseを返すと、そのアクション登録は中止となる(本関数の返り値にfalseを返す)。
$event = apply_filters( 'schedule_event', $event );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/cron.php

最終更新 : 2019年03月20日 16:49



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。