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



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。