フォームの必須エラーメッセージをHTML5標準にする方法、カスタマイズする方法
CakePHP4以降ではフォームのinputがrequiredの場合、ブランクで送信しようとすると「This field cannot be left empty」メッセージが表示されます。
HTML5標準ではブラウザ側の機能で、各言語に合わせたメッセージが表示されます。
日本語設定のGoogle Chromeでは、「このフィールドを入力してください。」となります。
CakePHPのメッセージではなく、HTML5のメッセージを表示するようにする方法の説明です。
ページごとの記述方法
サイト全体の記述方法
メッセージをカスタマイズする方法
この設定は、FormHelperの設定値「autoSetCustomValidity」です。
trueであればCakePHPのメッセージ、falseであればHTML5のメッセージが表示されます。
CakePHP3から実装され、CakePHP3ではデフォルト値がfalse、CakePHP4以降ではtrueになっています。
trueの場合
<input type="text" name="name" required="required" data-validity-message="This field cannot be left empty" oninvalid="this.setCustomValidity(''); if (!this.value) this.setCustomValidity(this.dataset.validityMessage)" oninput="this.setCustomValidity('')" id="name" aria-required="true">
falseの場合
<input type="text" name="name" required="required" id="name" aria-required="true">
ページごとの記述方法
ページごとに変更するには、ページのテンプレートファイルに下記を記述します。
$this->Form->setConfig('autoSetCustomValidity', false);
サイト全体の記述方法
サイト全体で変更するには、カスタムヘルパーに記述します。
[参考記事] 標準のHelperを拡張してカスタマイズする方法 CakePHP3、CakePHP4
ヘルパー全体での指定は initialize() に下記を記述します。
$this->setConfig('autoSetCustomValidity', false);
例
src/View/Helper/CustomFormHelper.php
<?php
declare(strict_types=1);
namespace App\View\Helper;
use Cake\View\Helper\FormHelper;
/**
* FormHelperの拡張ヘルパー
*
* @property \Cake\View\Helper\HtmlHelper $Html
* @property \Cake\View\Helper\UrlHelper $Url
* @link https://book.cakephp.org/4/ja/views/helpers/form.html
*/
class CustomFormHelper extends FormHelper
{
/**
* Constructor hook method.
*
* @param array<string, mixed> $config The configuration settings provided to this helper.
* @return void
*/
public function initialize(array $config): void
{
parent::initialize($config);
// HTML5メッセージをカスタムしない
$this->setConfig('autoSetCustomValidity', false);
}
}
__construct() でも書けますが、CakePHP準拠の記法は initialize() です。
public function __construct(View $view, array $config = [])
{
parent::__construct($view, $config);
// HTML5メッセージをカスタムしない
$this->setConfig('autoSetCustomValidity', false);
}
メッセージをカスタマイズする方法
CakePHPのメッセージ文言はi18nで制御されています。
国際化i18n(多言語化)
バリデーションエラーの文言は下記です。
#: ./vendor/cakephp/cakephp/src/Validation/Validator.php:2570 msgid "This field is required" msgstr "" #: ./vendor/cakephp/cakephp/src/Validation/Validator.php:2590 #: ./vendor/cakephp/cakephp/src/View/Form/ArrayContext.php:251 msgid "This field cannot be left empty" msgstr "" #: ./vendor/cakephp/cakephp/src/Validation/Validator.php:2742 msgid "The provided value is invalid" msgstr ""
/resources/locales/ja_JP/cake.po
msgid "This field is required" msgstr "この項目は必須です" msgid "This field cannot be left empty" msgstr "このフィールドを空のままにすることはできません" msgid "The provided value is invalid" msgstr "指定された値は無効です"
関連記事
- カラム一覧を取得する方法
- テンプレート(template)側でログイン情報を取得する方法
- 標準のHelperを拡張してカスタマイズする方法
- 国際化i18n(多言語化)
- URLをハイフン区切りからアンダーバー区切りやキャメルケースにする方法
- CakePHP4系の入手方法・インストール方法
- Composerコマンドでウクライナへのメッセージが表示されたことがあります
- Composerをインストールする方法と使い方
- コーディング規約のチェックを行う・整形する標準ツール(PHP CodeSniffer)の使い方
- Seedの実行順(外部キー制約などを先に実行させる方法) Foreign key violation
- Seedを実行した後にシーケンスを更新する方法(duplicate key valueエラー)
- SQLクエリー(SQL文)を直接実行する方法
- PostgreSQLでERROR: duplicate key value violates unique constraint "hoge_pkey" DETAIL: Key (id)=(10) already exists.と出る場合
- PostgreSQLで自動採番をするシーケンス(sequence)とは【AUTO INCREMENT】
- Apacheで所有権や書き込み権限があるにも関わらずPermissions deniedが出る場合
- CakePHP5
- CakePHP
- ログイン認証処理をする方法
- CakePHP5系の入手方法・インストール方法
- 複数のデータベースを切り替える方法(別データベースを使用する)
- デバッグレベルを設定
- [CakePHPのバグ]キャッシュ処理でunserializeエラーが発生する
- CakePHPのバージョンごとのシステム要件
- ディレクトリ構成
- CakePHP、Symfony、Zend Frameworkの比較
- セキュリティレベルの設定
- プライマリキーIDを連番数字ではなく推測しにくい文字列にする方法
- action名にlistは使えない listを使う方法
- CakePHP2系の入手方法・インストール方法
- キャッシュを有効にする
- CakePHPのエラーテンプレートの一覧
- CakePHP
スポンサーリンク
