• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/add settings field

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/add settings field」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

設定項目を設定ページとセクションへ登録します。

これは Settings API の一部です。設定項目を登録し、出力を制御するわずかなコールバックを使って、wp-admin 設定ページを自動的に生成します。

この関数を呼び出す前に、設定のページ($page)とページ内のセクション($section)を選んでおきます。

この関数で使う設定項目は register_setting()登録しておかなければなりません。そうしないと保存や更新が自動的に行われません。

コールバック関数は、以前の値を埋め込んだ適切な HTML の input 要素を出力する必要があります。ただし値の保存はシステムが行ってくれます。

HTML の input 要素の name 属性は、register_setting()$option_name に一致する必要があります。value 属性は get_option() を使って埋め込むことができます。

この関数を使って、"media" や "general" のような WordPress のデフォルトの設定ページに設定項目を登録することもできます。既存のセクションへ追加したり、add_settings_section() で作った新規セクションへ追加したりできます。

詳しくは Settings API をご覧ください。

使い方

<?php add_settings_field( $id, $title, $callback, $page, $section, $args ); ?>

パラメータ

$id
文字列) (必須) タグの 'id' 属性に使用する文字列。
初期値: なし
$title
文字列) (必須) フィールドのタイトル。
初期値: なし
$callback
文字列) (必須) フォームの一部として、適切な input 要素を含めてフィールドを出力する関数。引数として配列を一つ($args)渡す。input 要素の nameid はこの関数の $id と一致しなければならない。関数は出力を echo する必要がある。
初期値: なし
$page
文字列) (必須) フィールドを表示する設定ページ。add_theme_page() /en または do_settings_sections()$menu_slug に一致しなければならない。
初期値: なし
$section
文字列) (必須) ボックスを表示する設定ページのセクション(default または add_settings_section() で追加したセクション。既存のセクション名として何があるかはソースコードを参照)。
初期値: なし
$args
配列) (array()) オプション
初期値: なし

戻り値

(void) 
この関数は値を返さない。

用例

ラベルをつける

この例は「一般設定」ページへ ID を「myprefix_setting-id」とした設定項目を追加します。「myprefix」はあなたのプラグインやテーマに対応するユニークな文字列です。ラベルをセットするので、設定項目のタイトルをクリックするとフィールドにフォーカスが当たります。

add_settings_field( 'myprefix_setting-id',
	'This is the setting title',
	'myprefix_setting_callback_function',
	'general',
	'myprefix_settings-section-name',
	array( 'label_for' => 'myprefix_setting-id' ) );

変更履歴

新規導入: 2.7.0

ソースファイル

add_settings_field()wp-admin/includes/template.php にあります。

Settings API: register_setting(), unregister_setting(), add_settings_field(), add_settings_section(), add_settings_error(), get_settings_errors(), settings_errors(), settings_fields(), do_settings_sections(), do_settings_fields()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/add_settings_field最新版との差分