概要
add_settings_sectionアクションは、WordPressの設定ページに新しいセクションを追加するために使用されます。この関数は、プラグインやテーマにカスタム設定を追加する際に非常に便利です。よく使用される機能としては、以下のようなものがあります。
- プラグインの設定をまとめて表示するため。
- ユーザーの設定を整理するためのセクションを追加するため。
- テーマのカスタマイザーに情報を追加するため。
- オプション設定をグループ化するため。
- 説明を提供するためのセクションを作成するため。
- 各セクションにフックを付けてカスタム機能を追加するため。
- 管理画面のUIを改善するため。
- 設定項目を視覚的に分かりやすくするため。
構文
add_settings_section( $id, $title, $callback, $page );
パラメータ
$id(string) : セクションの識別子。ユニークな値である必要があります。$title(string) : セクションのタイトル。$callback(callable) : セクションの説明を生成する関数。$page(string) : このセクションが追加される設定ページのスラッグ。
戻り値
add_settings_sectionは戻り値を持たず、成功時には新しいセクションを作成します。
関連する関数
使用可能なバージョン
add_settings_sectionはWordPress 2.7.0以降で使用可能です。
ワードプレスコアファイルのパス
wp-admin/options.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
サンプルコード
サンプルコード1
add_action('admin_init', 'my_custom_settings');
function my_custom_settings() {
add_settings_section(
'my_custom_section',
'カスタム設定セクション',
'my_custom_section_callback',
'general'
);
}
function my_custom_section_callback() {
echo 'ここにセクションの説明を書きます。';
}
このサンプルコードは、一般設定ページに「カスタム設定セクション」という新しいセクションを追加し、その紹介文として説明を表示します。
サンプルコード2
add_action('admin_init', 'my_plugin_settings');
function my_plugin_settings() {
add_settings_section(
'my_plugin_section',
'プラグイン設定',
'my_plugin_section_callback',
'my_plugin_options'
);
}
function my_plugin_section_callback() {
echo '<p>このプラグインの設定をここで行います。</p>';
}
このサンプルコードは、独自のプラグイン設定ページに「プラグイン設定」セクションを追加しています。セクションの内容には、設定方法についての説明が含まれています。
サンプルコード3
add_action('admin_init', 'theme_custom_settings');
function theme_custom_settings() {
add_settings_section(
'theme_custom_section',
'テーマオプション',
'theme_custom_section_callback',
'theme_options'
);
}
function theme_custom_section_callback() {
echo 'ここにテーマのカスタマイズに関する情報を記載します。';
}
このサンプルコードは、テーマ設定ページに「テーマオプション」というセクションを追加し、その説明を提供します。
サンプルコード4
add_action('admin_init', 'custom_settings_setup');
function custom_settings_setup() {
add_settings_section(
'extra_settings_section',
'追加の設定',
'extra_settings_callback',
'extra_options_page'
);
}
function extra_settings_callback() {
echo 'このセクションには追加の設定オプションがあります。';
}
このサンプルコードでは、特定のオプションページに「追加の設定」セクションを追加し、その内容の説明文を表示します。
サンプルコード5
add_action('admin_init', 'example_plugin_settings');
function example_plugin_settings() {
add_settings_section(
'example_section',
'例の設定セクション',
'example_section_callback',
'example_plugin_options'
);
}
function example_section_callback() {
echo '<h3>例設定の説明</h3>';
}
このサンプルコードでは、特定のプラグインのオプションページに「例の設定セクション」を追加し、その説明としてHTML見出しを表示します。