VSCode is great, the fact that it can work with a vast amount of languages help’s it cater for everyone’s taste. One special tool that comes with VSCode is the Debug feature and when configured correctly, is a dream to use. If you’ve previously worked with Visual Studio 2017 for example, you will know what I mean. This guide will go through how to set-up the PHP xDebug module to work in tandem with VSCode, completely enabling full-on functional debugging across your application.
Getting the basics ready
To complete this tutorial you will need an installation of VSCode and as a bare minimum PHP 7.0. Of course, you will need a web server to run the PHP too, so make sure this is in place also. Once these are ready, make note of your PHP module directory, for example, mine is set to ‘C:\xampp\php\ext‘. This is were the XDebug module will reside.
Configuring PHP to use XDebug
Create an index.php file in the root directory of your web server, and add the following code.
<?php phpinfo(); ?>
Run the index.php file in a browser, preferably, Google Chrome. This will render the following information as shown in the image below –
Once this is loaded up, follow these sub-steps.
- Highlight all of the information on the page and copy it.
- Go to the XDebug Wizard tool.
- Paste the information into the Text Box input on the wizard tool page.
- Locate and click the ‘Analyse my
- Download the provided module under Instructions, number 1. (See image below)
Follow the remaining instructions in the image above but remember, in this example, the directory path may be different to your own. Do not forget to restart the web server after adding the module to the ext directory.
Let’s go ahead and configure the php.ini file to use the new xDebug module and set-up the extra settings to work with VSCode.
- Locate and open the php.ini configuration file, this will be inside the PHP root directory, for example, ‘C:\xampp\php\’.
- Add the settings below to the very bottom of the php.ini file.
- Important: Make sure that the zend_extension matches the one you have downloaded and residing in your php/ext folder.
- Also Important: Enabling remote_enable & remote_autostart must not be missed, otherwise, xDebug will not execute if either the browser or as singular script launch.
- Save it
- Restart the web server again.
[xDebug] zend_extension="php_xdebug-2.6.0-7.0-vc14.dll" xdebug.remote_enable = 1 xdebug.remote_autostart=on
Configuring VSCode to use PHP XDebug
Install the PHP Debug extension by Felix Becker. This can be done by clicking the extensions tab in VSCode and searching for ‘PHP Debug’.
Then, click on the Debug tab on the left-hand pane, click the debug drop-down and select Add Configuration.
Then, click the ‘PHP’ option from the drop-down that pops out.
After this point, VSCode will of created a launch.json file within your root directory inside the VSCode folder. There is one more step to take to make sure that the script execution works correctly.
Specify the runtimeExecutable which is the path to your PHP.exe interpreter. For example. mine looks like the following.
Now go ahead and save the launch.json file.
After following steps 1 and 2, you will be able to use the ‘Launch currently open script’ option, which will do exactly what it says on the tin. You can debug a single script without having to worry about a browser.
Now, if we want to be able to debug a script as a proper user, for example, debugging using a browser. This is always worth setting up because it’s extremely handy when debugging Get & Post to name a few.
What we need is an xDebug Helper, which is a Google Chrome extension available to use for free. Find the extension by going to the Google Chrome Web Store. See the following steps –
- Goto the following URL https://chrome.google.com/webstore/category/extensions
- Search for ‘xDebug Helper’
- Install the extension (It has a green ladybug in the logo) – See image below.
That is it, your VSCode is now prepared to debug your code.
How to use
Launch currently open script
Ok, so now both debug methods are set-up, how do we use them? It’s pretty simple. First of all, let us go through using the ‘Launch currently open script’ method.
- Go to any .php file, and add some breakpoints to your code (Shortcut is F9 on the keyboard).
- Make sure that ‘Launch currently open script’ is already selected in the Debug drop down in the top left of the debug window.
- Press F5 to start the debug process.
- You will see the debugger break at the first breakpoint, see the image below.
Listen for xDebug
Now, let’s go through the ‘Listen for xDebug method which takes the browser into account.
- Open a .php file, for this example the index.php file in the root directory.
- Add some code and add some breakpoints. Use F9 shortcut key to add breakpoints.
- Change the Debug select option to ‘Listen for xDebug’.
- Press F5 to start the debugger.
- Open Chrome and navigate to your index.php file, in my case its http://localhost/index.php
- Click the new XDebug Helper extension and click the Debug option.
- You will notice the helper icon will now turn green (See image below)
- Finally, refresh the page in the browser, and VSCode will react and start the debugging process.
- Go back into VSCode and you will see that it has stopped at the breakpoint.
Although this tutorial is pretty long-winded, you only have to do it once. I really advise the installation of XDebug Helper as it transforms debugging into another level. It’s free to use and invaluable.
If you struggle with this tutorial, or you get a different result to what has been stated in this article, please feel free to leave a comment.