add_settings_error()


WordPress関数add_settings_error()は、設定ページにエラーメッセージや通知を追加するために使用されます。

構文

add_settings_error( string $setting, string $code, string $message, string $type = 'error' );

引数の説明:

  • $setting (string) — エラーまたは通知が関連付けられる設定名。
  • $code (string) — ユニークなエラーコード。
  • $message (string) — 表示されるメッセージ。
  • $type (string) — エラータイプ（’error’, ‘success’, ‘warning’, ‘info’ のいずれか）。デフォルトは ‘error’。

例1: エラーメッセージの追加

以下は、設定ページにエラーメッセージを追加する例です。

add_settings_error( 'example_setting', 'example_error', '無効な値が入力されました。', 'error' );

例2: 成功メッセージの追加

以下は、成功メッセージを設定ページに追加する例です。

add_settings_error( 'example_setting', 'example_success', '設定が正常に保存されました。', 'success' );

例3: 複数の通知の追加

以下は、エラーと成功メッセージを同時に追加する例です。

add_settings_error( 'example_setting', 'example_error', '無効なデータがあります。', 'error' );
add_settings_error( 'example_setting', 'example_success', '一部の設定が保存されました。', 'success' );

例4: メッセージの表示

追加されたメッセージを表示するには、以下のコードを使用します。

<?php settings_errors(); ?>

例5: 条件に基づくエラーの追加

以下は、特定の条件下でエラーを追加する例です。

if ( empty( get_option( 'example_setting' ) ) ) {
    add_settings_error( 'example_setting', 'empty_error', '設定が空です。', 'error' );
}
?>

注意事項

  • settings_errors()関数を忘れずに呼び出し、メッセージを画面に表示してください。
  • ユニークなエラーコードを使用して、同じメッセージが重複して追加されるのを防ぎます。

関連機能：