【PHP】バックトーレス（呼び出し階層）をデバッグ出力する方法

2016年10月12日2022年11月2日

PHPでバックトレースを出力する方法について解説します。

バックトレースというのは、呼び出し階層のようなものです。
エラーが発生した時に、何行目でエラーが発生してどのようなルートでメソッドが呼び出されていったかが表示されますよね。

そのバックトーレスをエラーが発生していない時に出力する方法になります。

PHP標準の関数で出力する方法
クラス名やメソッド名など情報をカスタマイズして出力する方法

の２パターンの方法をご紹介します。

debug_print_backtrace()で呼び出し階層を一発出力

特に理由がなければこの方法が簡単です。

PHP標準で用意されているdebug_print_backtrace()を使います。

バックトレースを出力したい箇所で、debug_print_backtrace()をコールすればOKです。

下記のようなテキストが出力されます。

#0 c() called at [/tmp/include.php:10]
#1 b() called at [/tmp/include.php:6]
#2 a() called at [/tmp/include.php:17]
#3 include(/tmp/include.php) called at [/tmp/test.php:3]

リファレンスはこちら

カスタマイズしてクラス名・関数名・引数の値も出力できる

もう１つの方法は、少し手間をかけて出力する形式を自由にカスタマイズする方法です。

debug_backtrace()というメソッドは、バックトーレスの情報を配列で返します。
この情報を利用して、自由な形式で出力させます。

サンプルコード

    function print_debugtrace($printArgs = false) {
    	$dbg = debug_backtrace();
    	for ($i = 0; $i < count($dbg); $i++) {
    		echo $i . ")";
    		echo $dbg[$i]['file'];
    		echo "（" . $dbg[$i]['line'] . "）";
    		echo "：" . $dbg[$i]['class'];
    		echo $dbg[$i]['type'];
    		echo $dbg[$i]['function'];
    		echo "<br>";
    		
    		// 引数出力
    		if ($printArgs) {
    			echo "<div style='margin-left: 1.0em;'>";
    			print_r($dbg[$i]['args']);
    			echo "</div>";
    			echo "<br>";
    		}
    	}
    }