check_admin_referer

説明

bool check_admin_referer( [ mixed $action = -1 [ , string $query_arg = '_wpnonce' ] ] )
nonce用フォームパラメータを検証する。

パラメータ

  • $action
    ハッシュ生成時の文字列または数値を指定(省略時は-1)。
  • $query_arg
    nonce用ハッシュ値のタグ名を指定(省略時は'_wpnonce')。

返り値

チェックの結果、パラメータが有効な場合はtrueを、無効な場合はfalseを返す。ただしパラメータ$actionが-1以外か、リファラーURLがダッシュボードURL以外の場合は、チェック結果がfalseの時点で所定のメッセージを表示してリクエスト処理が終了(die)となる。

注意

検証対象のnonce用フォームパラメータは wp_nonce_field関数を使用して埋め込む。パラメータ$actionは互換性のために省略可になっているが、-1を指定することは3.2で不適切となった。


使用例

  • nonce用フォームパラメータを検証する。
    <?php check_admin_referer( 'my-plugin' ); ?>

フィルター

直接実行するフィルターはありません。

アクション

[1.5.1]検証結果を返す直前に'check_admin_referer'アクションを呼び出す。パラメータ$actionには本関数が受け取った値が、$resultには検証結果となる。
do_action( 'check_admin_referer', $action, $result );

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2022年07月01日 12:13



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。