Utiliser Xdebug avec Valet et WordPress

Bien que je ne sois pas fan de l’utilisation stricte des instructions var_dump ou echo comme moyen de déboguer le code, cela ne signifie pas qu’il n’y a pas de moments où elles sont utiles (sinon, elles ne feraient pas partie du langage, n’est-ce pas ?).

Mais que se passe-t-il si vous utilisez Laravel Valet (qui est assez facile à configurer pour WordPress) et que vous essayez d’afficher un tableau multidimensionnel et plutôt que d’obtenir une sortie bien formatée, vous finissez par obtenir une longue ligne de texte dans Times New Romain? Il y a de fortes chances que ce soit parce que vous n’avez pas Xdebug.

C’est assez facile à faire, mais c’est basé sur quelques choses différentes. De plus, une fois Xdebug installé, vous pouvez également utiliser un débogueur avec votre code. Ce n’est pas le but de ce post, cependant. 🙂

Obtenir toute cette configuration est assez facile, mais cela suppose ce qui suit :

1. Vous avez toutes les constantes nécessaires configurées pour le débogage de WordPress,
2. Vous avez Homebrew installé sur votre machine,
3. Vous êtes à l’aise pour éditer un fichier texte (techniquement, un fichier d’initialisation pour Xdebug, mais du texte quand même)
4. Vous êtes d’accord pour redémarrer Valet.

Pour vous assurer que WordPress est configuré pour afficher correctement les messages de débogage, assurez-vous que wp-config.php (ou tout autre fichier qui maintient vos constantes) contient les éléments suivants :

Notez qu’il existe d’autres constantes que vous pouvez utiliser, mais ce sont deux que je suis normalement fan d’inclure au minimum.

À partir de là, installez Homebrew. C’est aussi simple que la commande suivante, mais je vous recommande de lire cet article et la page d’accueil avant de l’exécuter :

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Une fois cela fait, vous devrez installer Xdebug. Cela suppose que vous utilisez PHP 7.1. Sinon, vous devrez installer le package correspondant à votre version de PHP. Mais en supposant que c’est exact, émettez ce qui suit dans votre terminal :

$ brew install php71-xdebug

Une fois Homebrew terminé, utilisez un éditeur de texte pour charger le fichier de configuration pour Xdebug. Pour cela, déposez la ligne suivante dans votre terminal :

$ atom /usr/local/etc/php/7.1/conf.d/ext-xdebug.ini

Ajoutez ensuite les lignes suivantes :

[xdebug]
zend_extension="/usr/local/opt/php71-xdebug/xdebug.so"
xdebug.remote_enable=true
xdebug.remote_host=localhost
xdebug.remote_port=9000
xdebug.remote_handler=dbgp

Cela configurera Xdebug, afin que la sortie du navigateur soit lisible et que vous puissiez utiliser des choses comme Xdebug pour déboguer votre code. Après cela, pour profiter de Xdebug avec Valet et WordPress, vous devrez redémarrer Valet :

$ valet restart

Et une fois fait, vous devriez être prêt à partir.