説明
パラメータ
- $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 );
$event = apply_filters( 'schedule_event', $event );
アクション
直接実行するアクションはありません。ソースファイル
/wp-includes/cron.php最終更新 : 2019年03月20日 16:49
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。