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



お勧め

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

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

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。