CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
2023/12/28
CakeDC/Usersのテンプレートの更新方法解説
「CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説」の記事で、CakePHP4環境に CakeDC/Usersをインストールしてユーザ登録、ログイン認証機能を実装する手順を解説しました。
今回の記事では、ユーザの新規登録する流れを追いながら、新規登録時に利用する画面、確認メールの本文のカスタマイズする方法を解説します。
解説は新規登録時に利用する画面についてだけですが、管理画面のテンプレートファイルも同様にカスタマイズ可能です。
また、基本的なカスタマイズの方法は、CakePHP3も CakePHP4も似ているのですが、あちこち異なるため、CakePHP3とは別の記事にしました。
ユーザの一覧・新規登録・更新の画面
インストールした CakeDC/Usersで構築された各画面の URLを記載します。
ログイン画面
http://example.com/login
http://example.com/users/login
ログアウト URL
http://example.com/logout
http://example.com/users/logout
管理側のユーザ一覧画面
http://example.com/users/index
管理側のユーザ登録・更新・削除・詳細画面
http://example.com/users/add
http://example.com/users/edit/:id
http://example.com/users/delete/:id
http://example.com/users/view/:id
※add以外は、アクセス時にパラメータとして IDが必要です
ユーザ側の新規登録画面
http://example.com/register
http://example.com/users/register
ユーザ側のユーザ登録時のメール認証のメール再送信画面
http://example.com/users/resend-token-validation
ユーザ側のユーザプロフィール画面(ログイン時)
http://example.com/users/profile
ユーザ側のパスワード変更画面(ログイン時)
http://example.com/users/change-password
ユーザ側のパスワードリセット画面(メールアドレス入力画面)
http://example.com/users/request-reset-password
例えば、「管理側のユーザ一覧画面」は、CakePHP3では
http://example.com/users/users/
でしたが、CakePHP4 では
http://example.com/users/index
となっています。また
http://example.com/users/
でもエラーとなるためご注意ください。
ユーザの新規登録の流れと設定項目
ユーザの新規登録の流れは、以下のようになります。
・フォームから情報を登録する
・入力したメールアドレスに確認用の URLが送信される
・URLをクリックすると本登録される
フォームから情報を登録する
まず最初は、フォームから情報を登録します。
ユーザ側の新規登録画面
http://example.com/register
この画面はユーザを登録する画面で、各項目を入力した後、「SUBMIT」をクリックすることで、入力した情報が保存されるとともに、入力したメールアドレスに、メールアドレス確認用のトークン付きのメールが送信されます。
入力フォームのテンプレートのカスタマイズ
CakeDC/Usersの入力フォームなどのテンプレートは、下記の場所に設置されています。
/vendor/cakedc/users/templates/Users
そのうちの下記「register.ctp」が、入力フォームのテンプレートになります。
/vendor/cakedc/users/templates/Users/register.php
上記のファイルを直接変更しても変更した内容は反映されますが、「/vendor/cakedc/users」にあるファイル一式はコアファイルですので、通常はこのファイルは変更しません。
テンプレートファイルをカスタマイズをする場合は、下記の場所にファイルをコピーして、コピーしたファイルを変更します。
/templates/Plugin/CakeDC/Users/Users/register.php
今回、初めてプラグインを使用する場合は、「/template」フォルダの中には「Plugin」以下のフォルダはありませんので、新規で作成してください。
また、テンプレートファイルの情報を汎用的に記述すると下記の様になります。
/templates/Plugin/CakeDC/Users/[Controller]/[view].php
ちなみに、CakePHP3と CakePHP4とではテンプレートファイルが置かれている場所が変更になっています。
CakePHP3:/src/Template/
CakePHP4:/templates/
フォルダの名称も「Template」から「templates」に変更されていますし、テンプレートファイルの拡張子も「.ctp」から「.php」に変更されています。
CakePHP3に慣れ親しんできた方は改めて確認してください。
プラグインのテンプレートをオーバーライドする方法についてさらに詳しい情報は、下記を参照してください。
https://book.cakephp.org/4/ja/plugins.html#id12
Accept TOS conditionsとは?
ちなみに、画面下にある「Accept TOS conditions?」は、「サービス利用規約に同意しますか?」という意味です。
「TOS」は「Terms of service」の略で、日本語で言うと「サービス利用規約」になります。
「TOS conditions」も「サービス利用規約の条件」ということですので、ほぼ同じ意味ですね。
入力したメールアドレスに確認用の URLが送信される
登録フォームから各情報を入力し、「SUBMIT」ボタンをクリックすると、入力情報が保存されるとともに、入力したメールアドレスにメール受信確認のためのメールが送信されます。
文面は、以下のような形式です。
1 2 3 4 |
Hi 【Fiest name】, [a:【token付きの認証用 URL】]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/templates/email/html/
/vendor/cakedc/users/templates/email/text/
このうちの下記「validation.ctp」が、登録時のメール本文のテンプレートになります。
/vendor/cakedc/users/templates/email/html/validation.php
テンプレートファイルをカスタマイズをする場合は、下記の場所にファイルをコピーし、コピーしたファイルを変更します。
/templates/Plugin/CakeDC/Users/email/html/validation.php
メール認証の流れ
登録フォームからユーザ登録をするときの流れを改めてご紹介しておきます。
まず、下記の登録フォームに各情報を入力し「submit」ボタンをクリックします。
http://example.com/register
そうすると、先に説明したメール受信を確認するための「Token付きの認証用 URL」が記載されたメールが届きます。
その記載された URLをクリックすると、メールが正しく受信されたとして処理され「users」テーブルの下記の項目が変更されます。
「users.token_expires」に入力されていた日時が「null」になる
「users.activation_date」が「null」からメール認証した日時になる
「users.active」が「0」から「1」になる
また、「CakeDC/Users」の認証処理では「users.active」が「1」のものをログイン許可をだす有効なアカウントとして処理をしています。
(「users.active」を「0」にすると、ID、PASSが合っていてもログイン認証が通らなくなります。)
XAMPPを利用している場合のメールの設定
登録フォームからメールを送信する処理で、サーバ環境にメールを送信する機能が実装されていない場合は、メール送信処理でエラーとなります。
ローカル環境を XAMPPで構築している方は「XAMPP環境(ローカル環境)の sendmailからPHPメールを送信する設定方法」に XAMPP環境からメールを送信する設定の記事を書いていますので、あわせてそちらを参考にしてください。
CakePHP4のCakeDC/Usersの関連記事
CakePHP4の CakeDC/Usersを使うために、基本となるインストールの方法から入力画面のテンプレートのカスタマイズや、リダイレクトの設定など、CakeDC/Usersに関する記事を下記に書いています。
あわせて参考にしてみてください。
CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説
以下は、CakePHP3 のときの 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のバリデーションのカスタマイズ方法解説
CakePHP4の関連記事
CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因CakePHP4のフラッシュメッセージの表示場所、デザインを変更する方法を解説
CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法
国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法
CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説
CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説
CakePHP4のメッセージ日本語化の設定(国際化と地域化の機能の使い方の解説)
CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()
CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
その他の「CakePHP4」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
CakePHP3の画像、ファイルアップロードプラグインUpload Plugin 3.0の設置解説・その1
CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその1で基本的な導入方法の解説で読みながら簡単に導入が可能。
-
CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数
CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。
-
CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除
CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。
-
CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説
CakePHP4で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定しそれを読み込み判別する。
-
CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法
CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。
-
CakePHP3のForm Helperの使い方のまとめ
CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。
-
CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装
CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。
-
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。
-
CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説
CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。
-
CakePHP3のルーティング(routes.php)の変更が反映されない時はキャッシュのクリアを
CakePHP3でルーティングの設定変更をしたけど反映されない!そんなときは慌てず騒がずキャッシュをクリアしよう!ルーティングの設定もキャッシュされることがあるらしい。