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

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

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

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

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

設定セクションは、WordPress 設定ページでヘッダを共有するいくつかの設定のまとまりです。プラグイン内で新規ページを作成するほか、既存の設定ページにセクションを追加できます。こうするとプラグインが管理しやすくなります。新しいページを増やさないので、ユーザーの学習も楽です。関連する既存ページで設定を変更するようユーザーに伝えればいいのです。

使い方

<?php add_settings_section( $id, $title, $callback, $page ); ?>

パラメータ

$id
文字列) (必須) タグの 'id' 属性に使用する文字列。
初期値: なし
$title
文字列) (必須) セクションのタイトル。
初期値: なし
$callback
文字列) (必須) 必要なコンテンツを入れてセクションを出力する関数。この関数は出力を echo する必要がある。
初期値: なし
$page
文字列) (必須) セクションを表示する設定ページ。add_theme_page() /en$menu_slug に一致しなければならない。
初期値: なし

戻り値

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

参考

コールバック関数は省略可能な引数をひとつ受け取ります。これは 3 つの要素を持つ配列です。 例えば:

add_settings_section(
	'eg_setting_section',
	'Example settings section in reading',
	'eg_setting_section_callback_function',
	'reading'
);
function eg_setting_section_callback_function( $arg ) {
	// セクションの紹介文を出力
	echo '<p>id: ' . $arg['id'] . '</p>';             // id: eg_setting_section
	echo '<p>title: ' . $arg['title'] . '</p>';       // title: Example settings section in reading
	echo '<p>callback: ' . $arg['callback'] . '</p>'; // callback: eg_setting_section_callback_function
}

変更履歴

新規導入: 2.7.0

ソースファイル

add_settings_section()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_section最新版との差分