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



お勧め

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 更新)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

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

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

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。

5.3の機能強化:カスタムフィールドキーの条件指定が使いやすくなる(2019年11月19日 更新)

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。