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

説明

do_settings_sections() は、登録された設定セクションと項目を出力する関数です。

基本構文

do_settings_sections( string $page ): void

引数

  • $page:設定ページのスラッグ

戻り値

戻り値はありません。

使い方(サンプル)

do_settings_sections( 'my-options' );

注意点

  • settings_fields() と submit_button() とセットで使います。

実務での使いどころ

  • 設定ページの <form> の中で、登録したセクションと、入力項目を、まとめて出力するとき。

よくあるミスと対処

  • $page が、add_settings_section()・add_settings_field() に渡したものと、違い、何も表示されない。
  • <form> や、送信ボタンを、用意していない。この関数が出力するのは、セクションと項目だけ。
  • settings_fields() を、呼んでいない。保存時に、エラーになる。

NG例

do_settings_sections( 'my-settings' ); // form も、settings_fields も、送信ボタンもない

OK例

<form method="post" action="options.php">
	<?php
	settings_fields( 'my_group' );
	do_settings_sections( 'my-settings' );
	submit_button();
	?>
</form>

使い分け早見表

関数 役割
do_settings_sections() セクションと項目を、出力する
settings_fields() 保存用の隠しフィールドを、出力する
submit_button() 送信ボタンを、出力する

関連項目

settings_fields()、add_settings_section()、submit_button()、add_settings_field()

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

コメント

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