PHPのdebug_backtrace()関数とは？バックトレースの取得方法と戻り値を解説

debug_backtrace()関数は、PHPの組み込み関数の一つで、バックトレース（関数呼び出しの履歴）を生成します。デバッグ作業において、「どのファイルのどの行から、どの関数やメソッドが呼び出されたのか」といった実行経路を把握したい場合に非常に役立ちます。

この関数は連想配列を返します。返される可能性のある要素は以下の表の通りです。

構文

debug_backtrace(options, limit)

パラメータ

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

  • DEBUG_BACKTRACE_PROVIDE_OBJECT：「object」インデックスを結果に格納するかどうかを指定します。
  • DEBUG_BACKTRACE_IGNORE_ARGS：メモリ消費を抑えるため、「args」インデックスおよびすべての関数・メソッドの引数を省略するかどうかを指定します。

• limit − 出力するスタックフレームの数を制限します。深い呼び出し階層を持つ大規模なアプリケーションのデバッグ時に有用です。

戻り値

debug_backtrace()関数は連想配列を返します。返される可能性のある要素については、上記の表を参照してください。

使用例

以下に具体例を示します。

<?php
    function display($str) {
        echo "Hi: $str";
        var_dump(debug_backtrace());
    }
    display('hello');
?>

出力結果

上記のコードを実行すると、次のような出力が得られます。

Hi: helloarray(1) {
    [0]=>
    array(4) {
       ["file"]=> string(36) "/var/www/tutorialspoint/php/test.php"
       ["line"]=> int(8)
       ["function"]=> string(7) "display"
       ["args"]=> array(1) {
          [0]=>
          &string(5) "hello"
       }
    }
}

このようにvar_dump()と組み合わせることで、呼び出し元のファイル名・行番号・関数名・引数などの情報を簡単に確認できます。エラーの原因調査や処理フローの追跡にぜひ活用してください。