CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

2025/03/08 2025/03/23

CakePHP4系、5系ではプラグイン「Authentication」を使用して認証処理を行う

　
CakePHP4系、CakePHP5系では Authenticationというプラグインを使用して、認証処理を行います。
Authentication Ver.2 は CakePHP4系で、Ver.3 は CakePHP5系で使用します。
　
CakePHP Authentication Ver.2
https://book.cakephp.org/authentication/2/ja/index.html
　
CakePHP Authentication Ver.3
https://book.cakephp.org/authentication/3/ja/index.html
　
　
実装方法は、下記の CakePHPオフィシャルサイトに詳しく紹介されていますので、おおよそ問題はないんじゃないかと思います。
　
Cookbook　CMS チュートリアル – 認証
https://book.cakephp.org/4/ja/tutorials-and-examples/cms/authentication.html
https://book.cakephp.org/5/ja/tutorials-and-examples/cms/authentication.html
　
Cookbook　シンプルな認証と認可のアプリケーション
https://book.cakephp.org/4/ja/tutorials-and-examples/blog-auth-example/auth.html
https://book.cakephp.org/5/ja/tutorials-and-examples/blog-auth-example/auth.html
　
ただ、1点だけ、CakePHP5系では、公式サイトの記述が間違っている点がありますので、下記の記事を確認していただいて、対応をしてください。
「CakePHP5系で認証機能のAuthenticationプラグインをインストール・エラー発生注意」
　
　

CakePHPの Authenticationでログインの有無と、ユーザ情報の取得方法

　
さて、前段が長くなりましたが、ログイン認証を実装したら、おおよそその次に行うであろう下記の方法について解説します。
　
・ログインしているかしていないかの判別
・ログインしているユーザの情報の取得
　
　
ちなみに、いずれも複数の方法があります。
好きな方法を使用すればいいかと思います。
　
　

`$this->Authentication->getResult()`を使用する方法

ログイン認証の有無の確認方法

　
まず最初は、「$this->Authentication->getResult()」を使用する方法です。
　

$result = $this->Authentication->getResult();
if ($result && $result->isValid()) {
  echo "ログインしている";
} else {
  echo "ログインしていない";
}

$result = $this->Authentication->getResult();

if ($result && $result->isValid()) {

echo "ログインしている";

} else {

echo "ログインしていない";

}

　
上記の 1行目のように「$this->Authentication」でログインユーザの値の取得を試行し、値が取得できたらログインできている、という判定を行うというものです。
　
https://book.cakephp.org/5/ja/tutorials-and-examples/cms/authentication.html#id3
この処理は、先に紹介した「CMS チュートリアル – 認証」の「ログイン追加」の項目にある「public function login()」で追加する、ログイン認証処理に記載がある方法です。
　
　
ログイン認証で使用する処理として Cookbookに紹介してあるくらいですので、非常に信頼できる方法かと思います。
　
　

ログインユーザの情報の取得方法

　
この方法で取得した「$result」には、ログイン認証の結果、および、ログインユーザの情報が入っています。
　

// ログイン認証を通過している場合は「SUCCESS」が取得できる
$this->Authentication->getResult()->getStatus();

// $result を使用する場合は下記となる
$result->getStatus();

// ログイン認証を通過している場合は「SUCCESS」が取得できる

$this->Authentication->getResult()->getStatus();

// $result を使用する場合は下記となる

$result->getStatus();

　
上記の方法でログインの状態のステータスを取得することができます。
取得できるステータスの種類については下記を参照してください。
　
Cookbook　Authentication3.x　認証 Component　-　ログイン状態を確認する
https://book.cakephp.org/authentication/3/ja/authentication-component.html#id2
　
　
この記事ではいろいろなログインユーザの情報を取得する処理を紹介していますが、このログインの状態を取得できる処理は多くないため、その点からこの「getResult()」を使用する処理が一番無難なような気がします。
　
　
また、上記の取得できるステータスを元に、下記のようにログイン判定をすることもできます。
　

if ($this->Authentication->getResult()->getStatus() == "SUCCESS") {
  echo "ログインしている";
} else {
  echo "ログインしていない";
}

if ($this->Authentication->getResult()->getStatus() == "SUCCESS") {

echo "ログインしている";

} else {

echo "ログインしていない";

}

　
　
ログインしているユーザ情報を取得する場合は下記のように記述します。
　

// ->getData() でログインユーザ全体の情報が取得できる
$loginUser = $this->Authentication->getResult()->getData();

// さらにカラム名を指定する事でそのカラムの値を取得できる
// 下記は「Users.name」というカラムがある想定
$name = $this->Authentication->getResult()->getData()->name;
$name = $this->Authentication->getResult()->getData()["name"];
$name = $loginUser->name;

// ->getData() でログインユーザ全体の情報が取得できる

$loginUser = $this->Authentication->getResult()->getData();

// さらにカラム名を指定する事でそのカラムの値を取得できる

// 下記は「Users.name」というカラムがある想定

$name = $this->Authentication->getResult()->getData()->name;

$name = $this->Authentication->getResult()->getData()["name"];

$name = $loginUser->name;

`$this->request->getAttribute('identity')`を使用する方法

ログイン認証の有無の確認方法

　
次は、「$this->request->getAttribute('identity')」を使用する方法です。
　

$result = $this->request->getAttribute('identity');
if($result){
  echo "ログインしている";
} else {
  echo "ログインしていない";
}

$result = $this->request->getAttribute('identity');

if($result){

echo "ログインしている";

} else {

echo "ログインしていない";

}

　
上記の 1行目のように「getAttribute('identity')」でログインユーザの値の取得を試行し、値が取得できたらログインできている、という判定を行うというものです。
　
先の「$this->Authentication」を使用する方法は、ログインしていない状態でも認証の可否などの情報を持っていますので、「$result」は「空」ではないですが、この「getAttribute('identity')」の処理は、認証できなかった場合は nullが戻ってくるため、上記のような判定になります。
　
https://book.cakephp.org/authentication/3/ja/identity-object.html
この処理は、上記の「Identity Objects」の解説に書いてある方法です。
　
　
私はこの方法を最初に知りましたので「getAttribute(‘identity’)」をメインに使っていましたが、取得できる情報は、先の「$this->Authentication」で取得できる情報とほぼ変わらない上に、ステータスは取得できないため、今後は「$this->Authentication」をメインに置き換えようと考えています。
　
　

ログインユーザの情報の取得方法

　
この方法で取得した「$result」には、ログインユーザの情報が入っています。
　

// カラム名を指定する事でそのカラムの値を取得できる（下記 3つの方法がある）
$name = $this->request->getAttribute('identity')->name;
$name = $this->request->getAttribute('identity')->get("name");
$name = $this->request->getAttribute('identity')["name"];

// 一度変数に入れる場合は下記のような記述になる
$result = $this->request->getAttribute('identity');
$name = $result->name;

// カラム名を指定する事でそのカラムの値を取得できる（下記 3つの方法がある）

$name = $this->request->getAttribute('identity')->name;

$name = $this->request->getAttribute('identity')->get("name");

$name = $this->request->getAttribute('identity')["name"];

// 一度変数に入れる場合は下記のような記述になる

$result = $this->request->getAttribute('identity');

$name = $result->name;

`$this->request->getAttribute('authentication')`を使用する方法

ログイン認証の有無の確認方法

　
続いては、「$this->request->getAttribute('identity')」を使用する方法です。
　

if ($this->request->getAttribute('authentication')->getResult()->getStatus() == "SUCCESS") {
  echo "ログインしている";
} else {
  echo "ログインしていない";
}

if ($this->request->getAttribute('authentication')->getResult()->getStatus() == "SUCCESS") {

echo "ログインしている";

} else {

echo "ログインしていない";

}

　
上記の 1行目のように「$this->request->getAttribute('authentication')->getResult()->getStatus()」で、ステータスが取得できますので、「SUCCESS」の場合は、ログインできている、と判別することができます。
　
　
ちなみに、一番最初の
「$this->Authentication->getResult()」
と
「$this->request->getAttribute('authentication')->getResult()」
は、まったく同じ情報を取得できます。
　
これは、「$this->Authentication」が「$this->request->getAttribute('authentication')」のエイリアスのような存在だからです。
厳密には、異なるようですが。
　
　

ログインユーザの情報の取得方法

　
上記のことから、ログインしているユーザ情報を取得する方法も「$this->Authentication」と同じで、下記のように取得することができます。
　

// ->getData() でログインユーザ全体の情報が取得できる
$loginUser = $this->request->getAttribute('authentication')->getResult()->getData();

// さらにカラム名を指定する事でそのカラムの値を取得できる
// 下記は「Users.name」というカラムがある想定
$name = $this->request->getAttribute('authentication')->getResult()->getData()->name;
$name = $this->request->getAttribute('authentication')->getResult()->getData()["name"];

// ->getData() でログインユーザ全体の情報が取得できる

$loginUser = $this->request->getAttribute('authentication')->getResult()->getData();

// さらにカラム名を指定する事でそのカラムの値を取得できる

// 下記は「Users.name」というカラムがある想定

$name = $this->request->getAttribute('authentication')->getResult()->getData()->name;

$name = $this->request->getAttribute('authentication')->getResult()->getData()["name"];

`$this->getRequest()->getSession()->read('Auth')`を使用する方法

ログイン認証の有無の確認方法

　
続いては、「$this->getRequest()->getSession()->read('Auth')」を使用して、セッション情報からログイン情報を取得する方法です。
　

if ($this->getRequest()->getSession()->read('Auth')) {
  echo "ログインしている";
} else {
  echo "ログインしていない";
}

if ($this->getRequest()->getSession()->read('Auth')) {

echo "ログインしている";

} else {

echo "ログインしていない";

}

　
上記の 1行目の「$this->getRequest()->getSession()->read('Auth')」でログインユーザ情報の取得を試行し、値が取得できたらログインできている、という判定を行うというものです。
ログインできていない場合は nullが返ってきます。
　
　

ログインユーザの情報の取得方法

　
取得できる情報は、一番最初の「$this->Authentication->getResult()」で取得できるユーザ情報と同じです。
ログイン認証できたユーザ情報をセッションに持たせているだけですので。
　
そのため、ユーザ情報を取得する方法は、セッション情報の取り扱い方と同じです。
　

// カラム名を指定する事でそのカラムの値を取得できる
// 下記は「Users.name」というカラムがある想定
$name = $this->getRequest()->getSession()->read('Auth')->name;
$name = $this->getRequest()->getSession()->read('Auth')->get("name");
$name = $this->getRequest()->getSession()->read('Auth.name');
$name = $this->getRequest()->getSession()->read('Auth')["name"];

// カラム名を指定する事でそのカラムの値を取得できる

// 下記は「Users.name」というカラムがある想定

$name = $this->getRequest()->getSession()->read('Auth')->name;

$name = $this->getRequest()->getSession()->read('Auth')->get("name");

$name = $this->getRequest()->getSession()->read('Auth.name');

$name = $this->getRequest()->getSession()->read('Auth')["name"];

View Helperを使用する方法

ログイン認証の有無の確認方法

　
最後は、View Helperを使用する方法です。
これは、View Helperの言葉の通り、Controllerではなく Viewでのみ使用可能です。
　
　
まず初めに、「/src/View/AppView」の「initialize」に下記の 6行目のコードを追加します。
　

public function initialize(): void
{
  parent::initialize();

  // ログインユーザ情報を取得するための Helper
  $this->loadHelper('Authentication.Identity');

}

public function initialize(): void

{

parent::initialize();

// ログインユーザ情報を取得するための Helper

$this->loadHelper('Authentication.Identity');

}

　
　
その上で、認証情報を利用をしたい Viewファイルに下記を記載します。
　

if ($this->Identity->isLoggedIn()) {
  echo "ログインしている";
} else {
  echo "ログインしていない";
}

if ($this->Identity->isLoggedIn()) {

echo "ログインしている";

} else {

echo "ログインしていない";

}

　
上記の 1行目の「$this->Identity->isLoggedIn()」で、ログイン認証の可否を取得できますので、それで判別します。
具体的には、ログインできているときは「true」、できていないときは「false」が返ってきます。
　
　

ログインユーザの情報の取得方法

　
ログインしているユーザ情報は下記のように取得することができます。
　

// カラム名を指定する事でそのカラムの値を取得できる
// 下記は「Users.name」というカラムがある想定
$name = $this->Identity->get("name");

// カラム名を指定する事でそのカラムの値を取得できる

// 下記は「Users.name」というカラムがある想定

$name = $this->Identity->get("name");

　
　
機能として提供されてはいますが、使うことはほとんどないのではないか、という感じがします。
認証情報はコントローラーでも使うと思いますので、コントローラーで取得したものをビューに渡して使用する方が自然な流れなような気がしますので。
　
　

ログアウトは`$this->Authentication->logout()`を実行する

　
最後に、ログアウトをするときの処理を書いておきます。
　
コントローラーの中に下記を書いておけば、そこでログアウトします。
　

$this->Authentication->logout();

1	$this->Authentication->logout();

- CakePHP 3.x 4.x 5.x CakePHP5

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: 国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

CakePHP4で定数に変数を埋め込み、翻訳機能「__()」で変数に値を入れる方法を紹介。定型の文章の一部だけを置換したい場合に利用すると便利。

: CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP3のCookbookにあるブックマークチュートリアル。ここで紹介されているタグで検索する処理を検索プラグイン「friendsofcake/search」で実現する方法を解説しました。

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。

: CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP4でテンプレートやレイアウトファイルをデフォルトから変更する場合は「render()」を使用するが、記述場所はできるだけコントローラー内の最後の方に書く方がいい。

: CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHP3でレコードを削除する際に関連するレコードをまとめて削除する機能の解説。フレームワークのメリットを存分に発揮し、コマンドを1行追加するだけで実装可能。

: CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

入力された値によってバリデーション（入力チェック）の内容を切り替える。その処理をCakePHPで実装する方法を解説。条件ごとに unset関数を使ってバリデーションを削除する、という方法を採る。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

PREV: CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介
NEXT: CakePHP4、5のユーザ認証でID、PASS以外の削除フラグなども条件加える方法

購読する

日	月	火	水	木	金	土
				1	2	3
4	5	6	7	8	9	10
11	12	13	14	15	16	17
18	19	20	21	22	23	24
25	26	27	28	29	30	31

CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系ではプラグイン「Authentication」を使用して認証処理を行う

CakePHPの Authenticationでログインの有無と、ユーザ情報の取得方法

`$this->Authentication->getResult()`を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

`$this->request->getAttribute('identity')`を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

`$this->request->getAttribute('authentication')`を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

`$this->getRequest()->getSession()->read('Auth')`を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

View Helperを使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

ログアウトは`$this->Authentication->logout()`を実行する

CakePHP5の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

国際化と地域化の翻訳機能「__()」を使って定数に変数を埋め込む方法

CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP4のController内でViewテンプレート、レイアウトの変更設定を記述する方法

CakePHP3のアソシエーション機能を使い関連レコードをまとめて削除

CakePHPのバリデーションを入力値・項目の条件によって変える方法を解説

CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力

CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系ではプラグイン「Authentication」を使用して認証処理を行う

CakePHPの Authenticationでログインの有無と、ユーザ情報の取得方法

$this->Authentication->getResult()を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

$this->request->getAttribute('identity')を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

$this->request->getAttribute('authentication')を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

$this->getRequest()->getSession()->read('Auth')を使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

View Helperを使用する方法

ログイン認証の有無の確認方法

ログインユーザの情報の取得方法

ログアウトは$this->Authentication->logout()を実行する

CakePHP5の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

`$this->Authentication->getResult()`を使用する方法

`$this->request->getAttribute('identity')`を使用する方法

`$this->request->getAttribute('authentication')`を使用する方法

`$this->getRequest()->getSession()->read('Auth')`を使用する方法

ログアウトは`$this->Authentication->logout()`を実行する