• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp schedule single event

提供: WordPress Codex 日本語版
< 関数リファレンス
2015年7月10日 (金) 20:44時点におけるMiccweb (トーク | 投稿記録)による版 (最新版のマージ)

移動先: 案内検索

指定した時間にWordPressのコアファイルによって一度だけ実行されるフックを登録します。アクションは誰かがWordPressサイトを訪れたときに予定した時間をすぎていれば実行されます。


パラメータ

$timestamp
integer) (必須) イベントを発生させたい時間です。UNIXのタイムスタンプ型でなくてはなりません。WP cron uses UTC/GMT time, not local time. Use time(), which is always GMT in WordPress. (current_time( 'timestamp' ) is local time in WordPress.
初期値: なし
$hook
string) (必須) 実行したいフックの名前
初期値: なし
$args
array) (オプション) フックした関数に渡す引数
初期値: なし

戻り値

(boolean|null) 
False if the event was cancelled by a plugin, null otherwise.

使用法

<?php wp_schedule_single_event( $timestamp, $hook, $args ); ?>

同じ名前のイベントを10分以下のタイミングで登録すると無視されるので注意してください。

Note that scheduling an event to occur before 10 minutes after an existing event of the same name will be ignored, unless you pass unique values for $args to each scheduled event. See wp_next_scheduled() for more information.

This behavior is subject to change, as the original intention of the code was to prevent scheduling two identical events within ten minutes of each other, not preventing scheduling of identical events until ten minutes after the next scheduled occurrence.

Attempts to schedule an event after an event of the same name and $args will also be ignored.


今から一時間後のイベントを登録する

function do_this_in_an_hour() {
// do something
}
add_action('my_new_event','do_this_in_an_hour');

// この行を関数の中に入れてください。
// すべてのページ訪問に応じて、
// ユーザーの操作に反応したり、新しいスケジュールを登録したりするものです。

wp_schedule_single_event( time() + 3600, 'my_new_event' );

// time()+3600 =今から1時間後

引数を指定して、今から一時間のイベントをスケジュールを設定

function do_this_in_an_hour( $arg1, $arg2, $arg3 ) {
    // do something
}
add_action( 'my_new_event', 'do_this_in_an_hour', 10, 3 );

// この行を関数の中に入れてください。
// すべてのページ訪問に応じて、
// ユーザーの操作に反応したり、新しいスケジュールを登録したりするものです。

wp_schedule_single_event( time() + 3600, 'my_new_event', array( $arg1, $arg2, $arg3 ) );

// time() + 3600 = one hour from now.

Wikipedia UNIX timestamp format

更新履歴

新規導入: 2.1.0

ソースファイル

wp_schedule_single_event()wp-includes/cron.phpにあります。

関連

Cron関数: spawn_cron /en, wp_cron /en, wp_schedule_event(), wp_schedule_single_event() /en, wp_clear_scheduled_hook() /en, wp_next_scheduled() /en, wp_unschedule_event() /en, wp_get_schedule() /en, wp_reschedule_event /en


関数リファレンステンプレートタグ目次もご覧ください。


このページ「関数リファレンス/wp schedule single event」は一部未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

最新英語版: WordPress Codex » wp_schedule_single_event最新版との差分