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



お勧め

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。