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

最終更新 : 2014年05月19日 09:37



お勧め

「順序」をtextからnumberに変更してみた(2018年5月27日 更新)

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。

新「WordPress Events and News」ウィジェットが興味深い(2018年5月27日 更新)

4.8のベータ版ですぐに新機能とわかるのが管理者ダッシュボードの新「WordPress Events and News」ウィジェット。ユーザーが指定した地域近隣で開催されるイベント情報を表示してくれるウィジェットで、この中のフォームがちょっと興味深かった。なおこの記事はWordPress 4.8 beta-2をもとにしており、以降のバージョンで変更される可能性があることをあらかじめ断っておく。

適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2016年12月15日 更新)

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。