settings_fields() の使い方｜説明・引数・注意点

説明

基本構文

settings_fields( string $option_group ): void

引数

• $option_group：register_setting() で指定したグループ名

戻り値

戻り値はありません。

使い方（サンプル）

settings_fields( 'my_group' );

注意点

• form タグの中で呼びます。
• アクションが options.php の場合に必須です。

実務での使いどころ

• 設定ページの <form> の中で、保存に必要な、隠しフィールド（nonceなど）を、出力するとき。

よくあるミスと対処

• <form> の送信先が、options.php になっていない。
• $option_group が、register_setting() で登録したものと、違う。保存時に、エラーになる。
• <form> の外で、呼んでいる。

NG例

<form method="post" action=""> <!-- 送信先が options.php でない -->
	<?php settings_fields( 'my_group' ); ?>

OK例

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

使い分け早見表

関連項目

register_setting()、do_settings_sections()、submit_button()

公式リファレンス：settings_fields() | Function | WordPress Developer Resources