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

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

関数リファレンス/get settings errors

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

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

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

$wp_settings_errors 配列をチェックして、現在のページ読み込み処理中に登録されたエラーを返します。

もし、変更が送信された($_GET['settings-updated'])直後で、設定エラーが 'settings_errors' Transient に保存されていた場合、そのエラーが代わりに返されます。これは前回のページ読み込みからエラーを受け渡すために使われます。

エラーを返す前に設定の値をもう一度無害化するには $sanitize 引数を使ってください。これは、ユーザーがデータを送信する前からエラーやお知らせがある場合に便利です。(ある設定ページを初めて読み込んだときや、admin_notices アクションフックの中で。)

使い方

<?php get_settings_errors( $setting, $sanitize ) ?>

パラメータ

$setting
文字列) (オプション) エラーを取得したい特定の設定項目のスラッグ名。
初期値: なし
$sanitize
真偽値) (オプション) エラーを返す前に設定の値をもう一度無害化するかどうか。
初期値: false

戻り値

(array) 
設定エラーを表す配列。
array(
    'setting' =>  $setting,
    'code'    =>  $code,
    'message' =>  $message,
    'type'    =>  $type
);

用例

参考


変更履歴

新規導入: 3.0

ソースファイル

get_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/get_settings_errors最新版との差分