説明
add_settings_error() は、設定画面に表示する通知メッセージを追加する関数です。
基本構文
add_settings_error( string $setting, string $code, string $message, string $type = 'error' ): void引数
$setting：設定名$code：コード$message：メッセージ$type：error/success/warning/info
戻り値
戻り値はありません。
使い方（サンプル）
add_settings_error( 'my_option', 'saved', '保存しました', 'success' );注意点
- サニタイズ用コールバックの中で呼ぶことが多い関数です。
実務での使いどころ
- 設定の保存時に、検証でエラーになった項目を、ユーザーへ知らせるとき。
- 保存の成功を、通知するとき。
よくあるミスと対処
$typeを、間違えている。指定できるのは、error・success・warning・info。- 表示する、
settings_errors()を、呼んでいない場合がある。「設定」メニューの下のページでは、自動で表示されるが、独自のトップレベルのページでは、自分で呼ぶ。 - メッセージを、エスケープしていない。
NG例
add_settings_error( 'my_option', 'invalid', 'エラー', 'danger' ); // type が、正しくないOK例
add_settings_error( 'my_option', 'invalid', '入力が正しくありません。', 'error' );使い分け早見表
| 関数 | 役割 |
|---|---|
add_settings_error() |
通知を、登録する |
settings_errors() |
登録した通知を、出力する |
wp_admin_notice() |
通知を、その場で出力する（WordPress 6.4以降） |
関連項目
settings_errors()、register_setting()
公式リファレンス：add_settings_error() | Function | WordPress Developer Resources
コメント