Add "Setting up Xdebug" section in PHP docs (#40470)

The page about PHP in the docs doesn’t explain how to use Xdebug. I had
a lof of trouble setting it up the first time, then recently had another
headache trying to get it to work again, because the value for `adapter`
had changed from `PHP` to `Xdebug`.

It’s likely that my example config isn’t perfect or has redundant stuff
or whatever, feel free to amend it.

I also took the liberty to set the Phpactor and Intelephense headings to
level 3 because I felt like they were part of "Choosing a language
server."

Release Notes:

- N/A
This commit is contained in:
Sylvain Brunerie 2025-10-20 11:44:58 +02:00 committed by GitHub
parent 92ff29fa7d
commit e3297cdcae
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -13,7 +13,7 @@ The PHP extension offers both `phpactor` and `intelephense` language server supp
`phpactor` is enabled by default.
## Phpactor
### Phpactor
The Zed PHP Extension can install `phpactor` automatically but requires `php` to be installed and available in your path:
@ -25,7 +25,7 @@ The Zed PHP Extension can install `phpactor` automatically but requires `php` to
which php
```
## Intelephense
### Intelephense
[Intelephense](https://intelephense.com/) is a [proprietary](https://github.com/bmewburn/vscode-intelephense/blob/master/LICENSE.txt#L29) language server for PHP operating under a freemium model. Certain features require purchase of a [premium license](https://intelephense.com/).
@ -60,3 +60,35 @@ To use the premium features, you can place your [licence.txt file](https://intel
Zed supports syntax highlighting for PHPDoc comments.
- Tree-sitter: [claytonrcarter/tree-sitter-phpdoc](https://github.com/claytonrcarter/tree-sitter-phpdoc)
## Setting up Xdebug
Zeds PHP extension provides a debug adapter for PHP and Xdebug. The adapter name is `Xdebug`. Here a couple ways you can use it:
```json
[
{
"label": "PHP: Listen to Xdebug",
"adapter": "Xdebug",
"request": "launch",
"initialize_args": {
"port": 9003
}
},
{
"label": "PHP: Debug this test",
"adapter": "Xdebug",
"request": "launch",
"program": "vendor/bin/phpunit",
"args": ["--filter", "$ZED_SYMBOL"]
}
]
```
In case you run into issues:
- ensure that you have Xdebug installed for the version of PHP youre running
- ensure that Xdebug is configured to run in `debug` mode
- ensure that Xdebug is actually starting a debugging session
- check that the host and port matches between Xdebug and Zed
- look at the diagnostics log by using the `xdebug_info()` function in the page youre trying to debug