wp_schedule_single_event

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

説明

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

パラメータ

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

返り値

基本的には何も返さない。アクションをスケジュールに追加した場合はtrueを、追加しなかった場合はfalseを返す。

注意

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

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

[5.1.0]スケジュールを登録できた場合にtrueを返すようになった（以前は何も返さない）。

使用例

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

フィルター

[5.1.0]次のスケジュールと比較する前に'pre_schedule_event'フィルターを呼び出す。パラメータ$preにはnullが、$eventにはhook、timestamp、schedule（値はfalse）、argsプロパティを持つイベント情報オブジェクトが格納されている。このフィルターで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_single_event

お勧め

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する（2012年3月15日 更新）

投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える（2014年9月12日 更新）

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。