• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/settings errors

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/settings errors」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

add_settings_error() で登録された設定エラーを表示します。

この関数は Settings API の一部です。get_settings_errors() で取得したエラーそれぞれを <div> で囲んで出力します。

この関数は Settings API による設定ページが送信された後に自動的に呼び出されます。エラーは、register_setting() で定義された設定項目の検証用コールバック関数の中で追加されます。

$sanitize 引数は get_settings_errors() へ渡されて、設定項目の現在の値をもう一度無害化します。

$hide_on_update 引数は、設定ページが初めて読み込まれたときだけエラーを表示します。

もしユーザーが新しい値を保存済みなら、送信直後のデフォルトのエラー通知で表示済みのメッセージを繰り返さないように隠します。

使い方

<?php settings_errors( $setting, $sanitize, $hide_on_update ) ?>

パラメータ

$setting
文字列) (オプション) エラーを表示したい特定の設定項目のスラッグ名。
初期値: なし
$sanitize
真偽値) (オプション) エラーを表示する前に設定の値をもう一度無害化するかどうか。
初期値: 'false'
$hide_on_update
真偽値) (オプション) true にすると、設定ページが送信済みならエラーを表示しません。
初期値: false

戻り値

(void) 
この関数は値を返さない。

用例

/**
 * 'your-settings-error-slug' に登録されたすべてのエラーを表示
 */
function your_admin_notices_action() {
    settings_errors( 'your-settings-error-slug' );
}
add_action( 'admin_notices', 'your_admin_notices_action' );

参考


変更履歴

新規導入: 3.0

ソースファイル

settings_errors()wp-admin/includes/template.php にあります。

Settings API: register_setting(), unregister_setting(), add_settings_field(), add_settings_section(), add_settings_error(), get_settings_errors(), settings_errors(), settings_fields(), do_settings_sections(), do_settings_fields()



関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/settings_errors最新版との差分