settings_errors()

WordPressのsettings_errors()関数は、設定ページで発生したエラーメッセージや成功メッセージを表示するために使用されます。この関数は、設定ページのフォーム送信後にユーザーにフィードバックを提供するために役立ちます。

構文

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

引数の説明:

• $setting(string) — エラーメッセージを表示する設定のスラッグ。空の場合、すべての設定エラーが表示されます。
• $sanitize(string) — メッセージをサニタイズするかどうかを指定します。デフォルトはfalseです。
• $hide_on_update(bool) — 更新時にメッセージを非表示にするかどうかを指定します。デフォルトはfalseです。

例1: すべての設定エラーメッセージを表示

この例では、すべての設定エラーメッセージを表示します。

<?php settings_errors(); ?>

例2: 特定の設定エラーメッセージを表示

この例では、特定の設定スラッグに関連するエラーメッセージを表示します。

<?php settings_errors('my_setting_slug'); ?>

例3: メッセージをサニタイズして表示

この例では、メッセージをサニタイズして表示します。

<?php settings_errors('my_setting_slug', true); ?>

例4: 更新時にメッセージを非表示にする

この例では、更新時にメッセージを非表示にします。

<?php settings_errors('my_setting_slug', false, true); ?>

例5: 成功メッセージを表示

この例では、設定が正常に更新された場合の成功メッセージを表示します。

<?php settings_errors(); ?>

例6: カスタムメッセージを追加

この例では、カスタムメッセージを追加して表示します。

add_settings_error('my_setting_slug', 'my_error_code', 'カスタムエラーメッセージ', 'error'); settings_errors('my_setting_slug');

例7: エラーメッセージのスタイルを変更

この例では、エラーメッセージのスタイルを変更します。

<?php settings_errors('my_setting_slug'); ?>
<style>.settings-error { border-left: 4px solid #ff0000; }</style>

例8: 複数の設定エラーメッセージを表示

この例では、複数の設定エラーメッセージを表示します。

add_settings_error('my_setting_slug1', 'my_error_code1', 'エラーメッセージ1', 'error'); add_settings_error('my_setting_slug2', 'my_error_code2', 'エラーメッセージ2', 'error'); settings_errors();

注意点

• settings_errors()関数は、設定ページでのみ使用することを推奨します。
• エラーメッセージは、設定フォームの上部に表示されます。
• カスタムメッセージを追加する場合は、add_settings_error()関数を使用します。