Become a Patron!
If Xdebug saves you time, please consider supporting the project.
» Documentation for: Xdebug 2

» Installation

This section describes on how to install Xdebug.

» Basic Features

Xdebug's basic functions include the display of stack traces on error conditions, maximum nesting level protection and time tracking.

» Variable Display Features

Xdebug replaces PHP's var_dump() function for displaying variables. Xdebug's version includes different colors for different types and places limits on the amount of array elements/object properties, maximum depth and string lengths. There are a few other functions dealing with variable display as well.

» Stack Traces

When Xdebug is activated it will show a stack trace whenever PHP decides to show a notice, warning, error etc. The information that stack traces display, and the way how they are presented, can be configured to suit your needs.

» Function Traces

Xdebug allows you to log all function calls, including parameters and return values to a file in different formats.

» Code Coverage Analysis

Code coverage tells you which lines of script (or set of scripts) have been executed during a request. With this information you can for example find out how good your unit tests are.

» Garbage Collection Statistics

Xdebug's built-in garbage collection statistics profiler allows you to find out when the PHP internal garbage collector triggers, how many variables it was able to clean up, how long it took, and how how much memory was actually freed.

» Profiling PHP Scripts

Xdebug's built-in profiler allows you to find bottlenecks in your script and visualize those with an external tool such as KCacheGrind or WinCacheGrind.

» Remote Debugging

Xdebug provides an interface for debugger clients that interact with running PHP scripts. This section explains how to set-up PHP and Xdebug to allow this, and introduces a few clients.

» Compatibility

Xdebug and PHP version compatibility


Frequently Asked Questions

» DBGP - A common debugger protocol for languages and debugger UI communication

» All Configuration Settings
» All Functions

This site and all of its contents are Copyright © 2002-2019 by Derick Rethans.
All rights reserved.