CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説
2024/06/21
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に慣れ親しんできた方は改めて確認してください。
また、「plugin」の「p」は、CakePHP3では大文字でしたが、CakePHP4では小文字になっています。この点も注意してください。
併せて、下記の記事も参考にしてください。
Windows環境の XAMPPを利用して CakePHPの開発する際の注意点
プラグインのテンプレートをオーバーライドする方法についてさらに詳しい情報は、下記を参照してください。
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の関連記事
CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説CakePHP4、CakePHP5の「warning: DebugKit is disabling...」の対処方法
MySQL+CakePHPのdate型、datetime型項目は「2999-12-31」までしか扱えない
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要
CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法
CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
CakePHP4から外部のデータベースにアクセスする方法解説
CakePHP4の数値項目は「like %10%」の部分一致検索(find select)はできない
CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説
その他の「CakePHP4」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。
-
-
CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定
CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。
-
-
CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する
CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK!ポイントはブロック化を有効にすること。
-
-
CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた
CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。
-
-
CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説
コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。
-
-
CakePHPで同一テーブル内の値を比較する条件でレコードを取得する方法
CakePHPの同一テーブルにある項目の値を比較し条件に合致するレコードを取得する方法を解説。[”項目名”=>”値”]ではなく[”項目名 = 項目名”]と書くところがポイント。
-
-
CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法
CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。
-
-
CakePHP4で定数の設定と呼び出し方法の解説(defineとConfigure)
CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。
-
-
CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法
CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース+解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。
-
-
CakePHP4のFrozenDateで1ヵ月前、先月、今月1日、来月末の日付などを算出する方法
CakePHPには「FrozenDate」の日付を扱う関数が用意されている。これを利用して、1ヶ月後、月末日、月初日、5日後などを指定して日付を取得できる。それを解説。