add_settings_section() の使い方|説明・引数・注意点

説明

add_settings_section() は、設定ページに、設定項目をまとめるセクションを追加する関数です。

基本構文

add_settings_section( string $id, string $title, callable $callback, string $page, array $args = array() ): void

引数

  • $id:セクションID
  • $title:見出し
  • $callback:説明文を出力する関数
  • $page:設定ページのスラッグ
  • $args:追加の引数

戻り値

戻り値はありません。

使い方(サンプル)

add_settings_section( 'my_section', '基本設定', '__return_false', 'my-options' );

注意点

  • admin_init フックで呼びます。

実務での使いどころ

  • 設定ページの、項目を、まとめるセクションを、作るとき。

よくあるミスと対処

  • $page が、do_settings_sections() に渡すものと、違う。セクションが表示されない。
  • admin_init フックの外で呼んでいる。
  • コールバックを、指定していない(空文字を渡す場合は、説明がなくてもよい)。

NG例

add_settings_section( 'main', '基本設定', '', 'my-page' ); // do_settings_sections( 'my-settings' ) と、ページ名が合わない

OK例

add_action( 'admin_init', function () {
	add_settings_section( 'main', '基本設定', '__return_empty_string', 'my-settings' );
} );
// 表示:do_settings_sections( 'my-settings' );

使い分け早見表

関数 役割
add_settings_section() 設定のセクションを、追加する
add_settings_field() 設定の入力項目を、追加する
do_settings_sections() 登録したセクションを、出力する

関連項目

add_settings_field()、register_setting()、do_settings_sections()

公式リファレンス:add_settings_section() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました