add_settings_error

今年一発目風邪引いた…( ꒪⌓꒪)

Function Reference/add settings error « WordPress Codex

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

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

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

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

とのこと。

register_setting() とは?

設定項目と無害化用コールバックを登録します。

これは Settings API の一部です。設定項目を登録し、出力を制御するわずかなコールバックを使って、wp-admin 設定ページを自動的に生成します。

この関数を使って、"media""general" のような WordPress のデフォルトの設定ページに設定項目を登録することもできます。(WordPress 4.1 以降、この関数は "permalink"ページへ追加された設定を保存しません。)設定項目を登録すると、add_settings_field() で既存のセクションへ追加したり、add_settings_section() で作った新規セクションへ追加したりできます。

[php]

<?php register_setting( $option_group, $option_name, $sanitize_callback ); ?>

[/php]

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

  • error
  • update

初期値:’error’

とのこと。なるほどー。