CakePHP4、CakePHP5の「warning: DebugKit is disabling．．．」の対処方法

2024/11/17 2025/01/31

CakePHPのDebugKitに関するワーニングを解消する方法解説

　
CakePHPで開発を行っていると、ローカル環境で「ログファイル（/logs/error.log）」に下記のようなワーニングが出力されていることがあります。
　
2024-01-01 00:00:00 warning: DebugKit is disabling itself as your host test.example.com is not in the known safe list of top-level-domains (localhost, invalid, test, example, local, internal). If you would like to force DebugKit on use the DebugKit.forceEnable Configure option.
　
メッセージの内容は、「DebugKitを使用していいリストにないので無効になってる」というものです。
　
これの解消方法を解説します。
　
　
この記事のポイントとしては、Gitなどのソース管理ツールを利用していても本番環境に影響がない（Git管理下にない）「/config/app_local.php」ファイルに設定する内容となっています。
　
そのため、CakePHP4系、CakePHP5系の記事としていますが、「/config/bootstrap.php」に設定する方法は CakePHP3でも有効ですので、お試しください。
　
　

/config/bootstrap.php に許可するトップレベルドメインを設定する

　
おそらく、「DebugKit」のワーニングに対するオーソドックスな対処方法は、「/config/bootstrap.php」に許可するトップレベルドメインを設定する方法です。
　
対象ファイル：/config/bootstrap.php
　
CakePHP5の場合は 116行目辺りに「if (Configure::read('debug')) {」の記述がありますので、その if文の中に下記を追記します。
　

  Configure::write('DebugKit.safeTld', ['com']); // .comドメインを登録する例

1	Configure::write('DebugKit.safeTld', ['com']); // .comドメインを登録する例

　
上記の例は「example.com」のように「.com」ドメインを登録するものですので、使用しているドメインに合わせて設定を変更してください。
　
　

/config/bootstrap.php に強制的に許可する設定をする・非推奨

　
前項のトップレベルドメインを設定する方法が推奨されていますが、強制的に許可する設定も用意されています。
公式サイトには、前項の方が安全なのでそちらがオススメ、と書いてありますが。
　
対象ファイル：/config/bootstrap.php
　
前項と同じく、CakePHP5の場合は 116行目辺りに「if (Configure::read('debug')) {」の記述がありますので、その if文の中に下記を追記します。
　

  Configure::write('DebugKit.forceEnable', true);

1	Configure::write('DebugKit.forceEnable', true);

/config/app_local.php に強制的に許可する設定をする

　
前項の設定は「bootstrap.php」に記述しました。
　
Gitなどのソース管理ツールを使用する場合、「bootstrap.php」ファイルはその管理下にあるファイルとなります。
そのため、本番環境にリリースする場合は「bootstrap.php」に設定した記述を変更する必要もあるかと思います。
　
そのため、Gitなどの管理下にない「app_local.php」に記述することで、影響範囲を開発で使用するローカル環境に留めることができる、という対応方法の紹介です。
　
対象ファイル：/config/app_local.php
　

  'DebugKit' => [
    'forceEnable' => true,
  ],

'DebugKit' => [

'forceEnable' => true,

　
上記の処理を「app_local.php」の最後の方などに追加します。
　
　

DebugKitの記事に関するおまけ

　
「bootstrap.php」に記述した下記の設定を「app_local.php」に記述する方法もあるようですが、いろいろと試してみましたが、私の環境では CakePHP4系、CakePHP5系のいずれも想定の動作はしませんでした。残念．．．
　

  Configure::write('DebugKit.safeTld', ['com']); // .comドメインを登録する例

1	Configure::write('DebugKit.safeTld', ['com']); // .comドメインを登録する例

　
　
また、この記事を書くにあたって参考にしたサイトは下記になります。
　
CakePHP4　オフィシャルサイト　Debug Kit　設定
https://book.cakephp.org/debugkit/4/ja/index.html#id2
　
CakePHP5　オフィシャルサイト　Debug Kit　設定
https://book.cakephp.org/debugkit/5/ja/index.html#id2
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

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

Message コメントをキャンセル

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

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

: CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説

CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。

: CakePHP3で値を入力直後にバリデーションする方法解説

CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3、CakePHP4では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHP 2.3　bakeの超初心者向けフォロー講座

CakePHP 2.3　bakeの超初心者向けフォロー講座

: CakePHP3、CakePHP4のdatetime型カラムの日時の扱い。秒まで表示する方法

CakePHP3の日時カラムで秒まで扱う場合はdate()、strtotime()関数ではうまくいかない。CakePHP3であらかじめ用意された「i18nFormat()」を使用する。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。