check_ajax_referer:WordPress私的マニュアル

check_ajax_referer

(2.0.3以降)
check_ajax_referer - AJAXリクエスト時にnonceパラメータを検証する

説明

bool check_ajax_referer( [ mixed $action = -1 [ , string $query_arg = false [ , bool $die = true ] ] ] )

AJAXリクエスト時にnonceパラメータを検証する。

パラメータ

$action
ハッシュ生成時の文字列または数値を指定（省略時は-1）。
$query_arg
nonce用ハッシュ値のタグ名を指定（省略時はfalse）。
$die
nonceパラメータの検証結果が無効な場合に強制終了する場合は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

参考

Code Reference: check_ajax_referer