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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

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

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

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

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

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。