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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。