CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
2019/04/06
CakeDC/Usersのテンプレートの更新方法解説
「CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応」の記事で、CakePHP3で CakeDC/Usersを使ってログイン認証機能を実装する手順を解説しました。
今回の記事では、ユーザの新規登録する流れを追いながら、新規登録時に利用する画面、確認メールの本文のカスタマイズする方法を解説します。
解説は新規登録時に利用する画面だけですが、管理画面のテンプレートファイルも同様にカスタマイズ可能です。
ユーザの一覧・新規登録・更新の画面
インストールした CakeDC/Usersで構築された各画面の URLを記載します。
ログイン画面
http://example.com/login
ログアウト URL
http://example.com/logout
管理側のユーザ一覧画面
http://example.com/users/users/
管理側のユーザ登録・更新・削除・詳細画面
http://example.com/users/users/add
http://example.com/users/users/edit/:id
http://example.com/users/users/delete/:id
http://example.com/users/users/view/:id
※add以外は、アクセス時にパラメータとして IDが必要です
ユーザ側の新規登録画面
http://example.com/users/users/register
ユーザ側のユーザ登録時のメール認証のメール再送信画面
http://example.com/users/users/resend-token-validation
ユーザ側のユーザプロフィール画面(ログイン時)
http://example.com//users/users/profile
ユーザ側のパスワード変更画面(ログイン時)
http://example.com/users/users/change-password
ユーザ側のパスワードリセット画面(メールアドレス入力画面)
http://example.com/users/users/request-reset-password
ユーザの新規登録の流れと設定項目
ユーザの新規登録の流れは、以下のようになります。
・フォームから情報を登録する
・入力したメールアドレスに確認用の URLが送信される
・URLをクリックすると本登録される
フォームから情報を登録する
まず最初は、フォームから情報を登録します。
ユーザ側の新規登録画面
http://example.com/users/users/register
この画面の情報を入力し、「SUBMIT」をクリックすることで、登録情報が保存されるとともに、メールアドレス確認用のトークン付きのメールが送信されます。
入力フォームのテンプレートのカスタマイズ
CakeDC/Usersの入力フォームなどのテンプレートは、下記の場所に設置されています。
/vendor/cakedc/users/src/Template/Users
そのうちの下記「register.ctp」が、入力フォームのテンプレートになります。
/vendor/cakedc/users/src/Template/Users/register.ctp
上記のファイルを直接変更しても変更した内容は反映されますが、「/vendor/cakedc/users」にあるファイル一式はコアファイルですので、通常はこのファイルを更新することはありません。
テンプレートファイルをカスタマイズをする場合は、下記の場所にファイルをコピーし、コピーしたファイルを変更します。
/src/Template/Plugin/CakeDC/Users/Users/register.ctp
ちなみに「/src/Template」フォルダの中には「Plugin」以下のフォルダはありませんので、新規で作成してください。
また、テンプレートファイルの情報を汎用的に記述すると下記の様になります。
/src/Template/Plugin/CakeDC/Users/[Controller]/[view].ctp
プラグインのテンプレートをオーバーライドする方法についてさらに詳しい情報は、下記を参照してください。
https://book.cakephp.org/3.0/ja/plugins.html#id11
Accept TOS conditionsとは?
ちなみに、画面下にある「Accept TOS conditions?」は、「サービス利用規約に同意しますか?」という意味です。
「TOS」は「Terms of service」の略で、日本語で言うと「サービス利用規約」になります。
「TOS conditions」も「サービス利用規約の条件」ということですので、ほぼ同じ意味ですね。
入力したメールアドレスに確認用の URLが送信される
登録フォームから各情報を入力し、「SUBMIT」ボタンをクリックすると、入力情報が保存されるとともに、入力したアドレスにアドレス確認のためのメールが送信されます。
文面は、以下のような形式です。
1 2 3 4 5 6 7 |
Hi 【Fiest name】, Activate your account here If the link is not correctly displayed, please copy the following address in your web browser 【token付きの認証用 URL】 Thank you, |
メール本文のテンプレートのカスタマイズ
登録時やパスワードをリセットする際などに送信されるメール本文のテンプレートは、下記の場所に設置されています。
/vendor/cakedc/users/src/Template/Email/html/
/vendor/cakedc/users/src/Template/Email/text/
このうちの下記「validation.ctp」が、登録時のメール本文のテンプレートになります。
/vendor/cakedc/users/src/Template/Email/html/validation.ctp
テンプレートファイルをカスタマイズをする場合は、下記の場所にファイルをコピーし、コピーしたファイルを変更します。
/src/Template/Plugin/CakeDC/Users/Email/html/validation.ctp
ちなみに「/src/Template」フォルダの中には「Plugin」以下のフォルダはありませんので、新規で作成してください。
XAMPPを利用している場合のメールの設定
登録フォームからメールを送信する処理で、サーバ環境にメールを送信する機能が実装されていない場合は、メール送信処理でエラーとなります。
今回 CakePHP3のアプリを開発している環境が XAMPP環境である場合は、「XAMPP環境(ローカル環境)の sendmailからPHPメールを送信する設定方法」に XAMPP環境からメールを送信する設定の記事を書いていますので、あわせてそちらを参考にしてください。
CakePHP3のCakeDC/Usersの関連記事
CakePHP3の CakeDC/Usersを使うために、基本となるインストールの方法から入力画面のテンプレートのカスタマイズや、リダイレクトの設定など、CakeDC/Usersに関する記事を下記に書いています。
あわせて参考にしてみてください。
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説
CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ
Google reCAPTCHAのSite key、Secret keyの取得方法・20170408バージョン
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakePHP3の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールするCakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。
-
-
CakePHP 2.3 bakeの超初心者向けフォロー講座
CakePHP 2.3 bakeの超初心者向けフォロー講座
-
-
CakePHP4のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP4の英語のメッセージを日本語化(多言語化)する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。
-
-
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。
-
-
CakePHP 2.3 テーブルの項目を演算した結果を条件として抽出する方法
アソシエーション(連携)している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。
-
-
CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root/Homeのリンクなども
CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。
-
-
CakePHP 2.3 Search Pluginで検索処理 その4前方一致検索、後方一致検索、不等号による検索、between句による範囲検索
CakePHPの検索プラグイン Search Pluginの検索処理の中で前方一致検索、後方一致検索、不等号による検索、between句による範囲検索の解説です。
-
-
CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応
CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。
-
-
CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法
CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。
-
-
CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法
CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース+解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。