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

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

「関数リファレンス/add settings error」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(見出しとリンク先のみ和訳。)
(最初の和訳。)
 
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
 +
{{NeedTrans|[[#Notes|参考]] 節が}}
  
 
<div id="Description">
 
<div id="Description">
5行目: 6行目:
 
</div>
 
</div>
  
Register a settings error to be displayed to the user.
+
ユーザーへ表示するために設定エラーを登録します。
  
Part of the [[Settings API]]. Use this to show messages to users about settings validation problems, missing settings or anything else.
+
この関数は [[Settings API]] の一部です。設定の検証で問題があったときや設定の不足など任意のメッセージを表示するのに使います。
  
Settings errors should be added inside the <tt>$sanitize_callback</tt> function defined in [[関数リファレンス/register_setting|<tt>register_setting()</tt>]] for a given setting to give feedback about the submission.
+
入力値についてフィードバックを返すため、設定エラーは [[関数リファレンス/register_setting|register_setting()]] で定義する <tt>$sanitize_callback</tt> 関数の中で追加します。
  
By default messages will show immediately after the submission that generated the error. Additional calls to <tt>settings_errors()</tt> can be used to show errors even when the settings page is first accessed.
+
デフォルトでは、エラーが発生した入力の直後にメッセージを表示します。追加の <tt>settings_errors()</tt> 呼び出しを利用して、設定ページを初めてアクセスしたときにメッセージを表示することもできます。
  
 
<div id="Usage">
 
<div id="Usage">
23行目: 24行目:
 
</div>
 
</div>
  
{{Parameter|$setting|string|Slug title of the setting to which this error applies.}}
+
{{Parameter|$setting|文字列|エラーを適用する設定項目のスラッグ名。}}
{{Parameter|$code|string|Slug-name to identify the error. Used as part of 'id' attribute in HTML output. A prefix of 'setting-error-' will be added to the string in $code and assigned to the 'id' attribute of the outermost &lt;div&gt; for this error.}}
+
{{Parameter|$code|文字列|エラーを特定するスラッグ名。HTML 出力の 'id' 属性に含められる。<tt>$code</tt> の文字列の前に '<tt>setting-error-</tt>' が付加され、このエラーを囲む一番外側の <nowiki><div></nowiki> の 'id' 属性に入る。}}
{{Parameter|$message|string|The formatted message text to display to the user (will be shown inside styled <nowiki><div></nowiki> and <nowiki><p></nowiki>).}}
+
{{Parameter|$message|文字列|ユーザーへ表示するフォーマット済みメッセージ。スタイル付きの <nowiki><div></nowiki> <nowiki><p></nowiki> で囲んで表示される。}}
{{Parameter|$type|string|The type of message it is. $type will be add an HTML class of the same name of the outermost <nowiki><div></nowiki>. To add multiple classes separate them with a space.<ul><li>''error''</li><li>''updated''</li></ul>|optional|'error'}}
+
{{Parameter|$type|文字列|メッセージの種類。<tt>$type</tt> がそのまま、一番外側の <nowiki><div></nowiki> のクラスに追加される。複数のクラスを追加するにはスペースで区切る。<ul><li>''error''</li><li>''updated''</li></ul>|オプション|'error'}}
  
 
<div id="Return_Values">
 
<div id="Return_Values">
32行目: 33行目:
 
</div>
 
</div>
  
; (void) : This function does not return a value.
+
; (void) : この関数は値を返さない。
  
 
<div id="Examples">
 
<div id="Examples">
92行目: 93行目:
 
</div>
 
</div>
  
Since: [[Version_3.0|3.0]]
+
新規導入: [[Version_3.0|3.0]]
  
 
<div id="Source_File">
 
<div id="Source_File">
98行目: 99行目:
 
</div>
 
</div>
  
<tt>add_settings_error()</tt> is located in {{Trac|wp-admin/includes/template.php}}.
+
<tt>add_settings_error()</tt> {{Trac|wp-admin/includes/template.php}} にあります。
  
 
<div id="Related">
 
<div id="Related">

2015年8月23日 (日) 16:30時点における最新版

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

このページ「関数リファレンス/add settings error」は参考 節が未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

ユーザーへ表示するために設定エラーを登録します。

この関数は Settings API の一部です。設定の検証で問題があったときや設定の不足など任意のメッセージを表示するのに使います。

入力値についてフィードバックを返すため、設定エラーは register_setting() で定義する $sanitize_callback 関数の中で追加します。

デフォルトでは、エラーが発生した入力の直後にメッセージを表示します。追加の settings_errors() 呼び出しを利用して、設定ページを初めてアクセスしたときにメッセージを表示することもできます。

使い方

<?php add_settings_error( $setting, $code, $message, $type ) ?>

パラメータ

$setting
文字列) (必須) エラーを適用する設定項目のスラッグ名。
初期値: なし
$code
文字列) (必須) エラーを特定するスラッグ名。HTML 出力の 'id' 属性に含められる。$code の文字列の前に 'setting-error-' が付加され、このエラーを囲む一番外側の <div> の 'id' 属性に入る。
初期値: なし
$message
文字列) (必須) ユーザーへ表示するフォーマット済みメッセージ。スタイル付きの <div> と <p> で囲んで表示される。
初期値: なし
$type
文字列) (オプション) メッセージの種類。$type がそのまま、一番外側の <div> のクラスに追加される。複数のクラスを追加するにはスペースで区切る。
  • error
  • updated
初期値: 'error'

戻り値

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

用例

function change( $data ) {

    $message = null;
    $type = null;

    if ( null != $data ) {

        if ( false === get_option( 'myOption' ) ) {

            add_option( 'myOption', $data );
            $type = 'updated';
            $message = __( 'Successfully saved', 'my-text-domain' );

        } else {

            update_option( 'myOption', $data );
            $type = 'updated';
            $message = __( 'Successfully updated', 'my-text-domain' );

        }

    } else {

        $type = 'error';
        $message = __( 'Data can not be empty', 'my-text-domain' );

    }

    add_settings_error(
        'myUniqueIdentifyer',
        esc_attr( 'settings_updated' ),
        $message,
        $type
    );

}

参考

The problem only occurs when I use add_menu_page() or add_submenu_page(). The validation errors are not shown.

A simple work around is to add settings_errors() to my options page, which will make the notification box show... However, seems like a dirty fix

<h2>The heading of my settings page</h2>
<?php settings_errors(); ?>

変更履歴

新規導入: 3.0

ソースファイル

add_settings_error()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/add_settings_error最新版との差分