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

説明

基本構文

settings_errors( string $setting = '', bool $sanitize = false, bool $hide_on_update = false ): void

引数

• $setting：設定名
• $sanitize：サニタイズ用のエラーを再取得するか
• $hide_on_update：更新時に隠すか

戻り値

戻り値はありません（出力します）。

使い方（サンプル）

settings_errors();

注意点

• 「設定」メニュー配下のページでは、自動で出力されます。

実務での使いどころ

• 独自のメニューのページで、保存時の通知を、表示するとき。

よくあるミスと対処

• 「設定」メニューの下のページ（add_options_page()）でも、呼んで、通知が、二重に表示される。このページでは、自動で表示される。
• 独自のトップレベルのページで、呼ばず、通知が、表示されない。
• $setting を、指定せず、他の設定の通知も、表示される。

NG例

// add_menu_page で作ったページで、通知の出力を呼んでいない

OK例

function my_settings_page() {
	?>
	<div class="wrap">
		<h1>サイト設定</h1>
		<?php settings_errors(); ?>
		<form method="post" action="options.php">
			<?php settings_fields( 'my_group' ); do_settings_sections( 'my-settings' ); submit_button(); ?>
		</form>
	</div>
	<?php
}

使い分け早見表

関連項目

add_settings_error()

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