wp_nonce_field

説明

string wp_nonce_field( [ mixed $action = -1 [ , string $name = "_wpnonce" [ , bool $referer = true [ , bool $echo = true ] ] ] ] )
nonce用フォームパラメータ(HTMLタグ)を表示する。

パラメータ

  • $action
    ハッシュ生成時の文字列または数値を指定(省略時は-1)。
  • $name
    nonce用ハッシュ値のタグ名を指定(省略時は'_wpnonce')。
  • $referer
    リファラータグを出力する場合はtrueを指定(省略時はtrue)。
  • $echo
    nonce用HTMLタグを表示する場合はtrueを指定(省略時はtrue)。

返り値

nonce用フォームパラメータを返す。

注意

プラグインやテーマのフォーム内で呼び出して使用する。埋め込んだnonce用の値の妥当性は、サブミット時に check_admin_referer関数でチェックする。

次の例に示すhidden属性のinputタグをパラメータ$nameの名前で出力する。
<input type="hidden" id="_wpnonce" name="_wpnonce" value="a0360fd7b2" />
パラメータ$refererがtrueの場合は、次のようなhidden属性のinputタグも出力する。
<input type="hidden" name="_wp_http_referer" value="/wp-admin/options-general.php?page=my-plugin-properties">

使用例

  • nonce用フォームパラメータを表示する。
    <?php wp_nonce_field( 'my-plugin' ); ?>
  • nonce用フォームパラメータを取得する。
    <?php wp_nonce_field( 'my-plugin', '_wpnonce', true, false ); ?>

フィルター

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

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

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



お勧め

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?