wp_schedule_event

（2.1.0以降）
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

関連

参考

Code Reference: wp_schedule_event

お勧め

テーブルブロックを定形に整える（2021年12月27日 更新）

ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。

各種リンクを取得する関数一覧（2014年6月12日 更新）

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク（パーマリンク）を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

スクリプトファイルのバージョンパラメータを変更する（2018年5月27日 更新）

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する（2018年5月27日 更新）

ダッシュボードの「アクティビティ」ウィジェットは「投稿（post）」の状況を表示し、固定ページ（page）やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）

WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。