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 コメントをキャンセル

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

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

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

: CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。

: getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

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

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

: CakePHP4のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつ、テンプレートファイル、設定情報ファイルの場所とそれらをカスタマイズする方法を説明します。

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

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