PHP error handling functions - debug_backtrace()

Last update on August 19 2022 21:50:39 (UTC/GMT +8 hours)

Introduction

The debug_backtrace() function is used to generate a PHP backtrace.

Syntax:

debug_backtrace(provide_object )

Parameters:

provide_object: Specifies whether the object index is to be populated or not. Type of provide_object is boolean.

Return Values:

debug_backtrace() function returns an associative array. Here is a list of the possible returned elements :

Name	Type	Description
function	string	Name of the current function.
line	integer	The Current line number.
file	string	The Current file name.
class	string	The Current class name.
object	object	The Current object name.
type	string	Specifies the current call type.
		For a method call.	-> is returned.
		For a static method call.	:: is returned.
		For a function call.	nothing is returned.
args	array	If inside a function.	this lists the functions arguments.
args	array	If inside an included file.	this lists the included file name(s).

Example:

<?php
function w3r($str)
{
    echo "We are learning:".$str."<br />";
    var_dump(debug_backtrace());
}
w3r('php');
?>

The above code displays this output:

We are learning:php
array(1) {
  [0]=>
  array(4) {
    ["file"]=>
    string(92) "C:\Program Files\Apache Software Foundation\Apache2.2\htdocs\php\debug-backtrace-example.php"
    ["line"]=>
    int(8)
    ["function"]=>
    string(3) "w3r"
    ["args"]=>
    array(1) {
      [0]=>
      &string(3) "php"
    }
  }
}

Previous: using-die()
Next: debug_print_backtrace()