wp_schedule_single_event

(2.1.0以降)
wp_schedule_single_event - 一度だけ実行するアクションをスケジュールに登録する

説明

void wp_schedule_single_event( int $timestamp, string $hook [ , array $args = array() ] )
一度だけ実行するアクションをスケジュールに登録する。

パラメータ

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

返り値

基本的には何も返さない。

注意

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

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

使用例

  • アクション名'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.' ) );
    ?>

フィルター

[3.1.0]アクションの登録前に'schedule_event'フィルターを呼び出す。パラメータ$eventには、'hook'、'timestamp'、'schedule'(値はfalse)、'args'プロパティを持つstdClassオブジェクトが格納されている。フィルター関数でfalseを返すと、そのアクション登録は中止となる(本関数の返り値にfalseを返す)。
$event = apply_filters( 'schedule_event', $event );

アクション

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

ソースファイル

/wp-includes/cron.php

関連

  • wp_next_scheduled - スケジュールに登録されているアクションの実行時間を取得する
  • wp_unschedule_event - 登録済みのアクションをスケジュールから外す

お勧めコンテンツ

タイトルが一致する投稿を検索する(2014年2月20日 登録)

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 登録)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

カスタムフィールドで並び替え(2013年8月9日 登録)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

初期化に関連するアクションのおさらい(2012年8月7日 登録)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

決まった値を返すだけの関数群(2015年7月15日 登録)

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

最終更新日時 : 2014-05-26 10:06