PHPのdebug_print_backtrace()関数でバックトレースを出力する方法

PHPのdebug_print_backtrace()関数は、現在のコールスタック（バックトレース）をそのまま出力するためのデバッグ用関数です。どの関数がどの順番で呼び出されたのか、呼び出し元のファイル名や行番号まで確認できるため、エラーの原因追跡や処理の流れの把握に非常に役立ちます。なお、この関数は戻り値を持ちません。

構文

debug_print_backtrace(options, limit)

パラメータ

• options − 以下のオプションを組み合わせて指定するためのビットマスクです。

• DEBUG_BACKTRACE_IGNORE_ARGS: 「args」インデックスおよびすべての関数・メソッドの引数を省略するかどうかを指定します。trueにするとメモリ消費を抑えられます。

• limit − 出力するスタックフレームの最大数を制限します。デフォルトは0で、すべてのフレームが出力されます。

戻り値

debug_print_backtrace()関数は値を返しません。バックトレース情報は直接標準出力へ書き出されます。

使用例

以下は、複数の関数をネストして呼び出し、最も深い位置にある関数内でdebug_print_backtrace()を実行する例です。

<?php
function Test1() {
    Test2();
}
function Test2() {
    Test3();
}
function Test3() {
    Test4();
}
function Test4() {
    debug_print_backtrace();
}
Test1();
?>

出力結果

このコードを実行すると、関数の呼び出し経路が次のように表示されます。

#0  Test4() called at [/home/cg/root/4127336/main.php:12]
#1  Test3() called at [/home/cg/root/4127336/main.php:8]
#2  Test2() called at [/home/cg/root/4127336/main.php:4]
#3  Test1() called at [/home/cg/root/4127336/main.php:16]

このように、スタックの先頭（#0）には現在実行中の関数が表示され、その下に呼び出し元の関数、ファイル名、行番号が順に並びます。大規模なアプリケーションで「どこからこの関数が呼ばれたのか」を調べたい場合や、予期しない動作の原因を特定したい場合に、この関数を使うことでデバッグ作業を効率化できます。