説明
bool check_ajax_referer( [ mixed $action = -1 [ , string $query_arg = false [ , bool $die = true ] ] ] )
AJAXリクエスト時にnonceパラメータを検証する。
パラメータ
- $actionハッシュ生成時の文字列または数値を指定（省略時は-1）。
- $query_argnonce用ハッシュ値のタグ名を指定（省略時はfalse）。
- $dienonceパラメータの検証結果が無効な場合に強制終了する場合はtrueを指定（省略時はtrue）。
返り値
チェックの結果、パラメータが有効な場合はtrueを、無効な場合はfalseを返す。ただしパラメータ$dieがtrueでチェック結果がfalseの場合は、リクエスト処理が終了（die）となる。注意
check_admin_referer関数は、フォームサブミット時のnonceパラメータを検証に用いるが、本関数はAJAXリクエスト時のパラメータを検証する場合に用いる。nonceパラメータ名は、パラメータ$query_argの値、'_ajax_nonce'、'_wpnonce'の順にその有無が確認され、先に見つかったものがnonceパラメータとなる。
なおnonceパラメータの無効時に独自の処理を行う場合は、パラメータ$dieにfalseを指定する。
使用例
- AJAXリクエスト時にnonceパラメータを検証する。<?php check_ajax_referer( 'my-action' ); ?>
- AJAXリクエスト時にnonceパラメータ名'my-ajax-nonce'の値を検証する。<?php check_ajax_referer( 'my-action', 'my-ajax-nonce' ); ?>
- AJAXリクエスト時にnonceパラメータを検証し、検証結果を調べる。<?php if ( check_ajax_referer( 'my-action', false, false ) ) : ?>
フィルター
直接実行するフィルターはありません。アクション
[2.1.0]検証結果を返す直前に'check_ajax_referer'アクションを呼び出す。パラメータ$actionには本関数が受け取った値が、$resultには検証結果となる。do_action( 'check_ajax_referer', $action, $result );ソースファイル
/wp-includes/pluggable.php.php最終更新 : 2014年07月19日 12:37
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。