Déboguer WordPress avec Ray, Partie 1
TL; DR : Cet article donne un aperçu de haut niveau du type d’application Ray et de la manière de le configurer pour une utilisation dans WordPress.
Depuis que je suis impliqué dans le développement de WordPress, j’ai toujours vu des développeurs – moi y compris – utiliser systématiquement [print_r](https://www.php.net/manual/en/function.print-r.php)et [var_dump](https://www.php.net/manual/en/function.var-dump.php)chaque fois qu’ils ont besoin de voir ce qui se passe dans leur code.
Et cela convient aux petites structures de données telles que les regards sur les objets, les tableaux, etc. Ensuite, à l’autre extrémité du spectre de débogage, si vous avez besoin de parcourir le code pour voir quels arguments sont passés dans une fonction donnée à partir d’où et avec quelle valeur, alors utiliser quelque chose comme Xdebug est incroyablement utile.
Jusqu’à récemment, je ne pensais pas qu’il y avait un juste milieu. Mais ensuite j’ai trouvé Ray et je l’utilise depuis.
Déboguer WordPress avec Ray, Partie 1
Qu’est-ce que Ray ?
Avant de parler de débogage de WordPress avec Ray, il est utile de comprendre ce qu’est Ray et ce qu’il n’est pas.
Le premier étant que ce n’est pas quelque chose qui est exclusivement WordPress, donc si vous êtes tombé sur ce message en tant que quelqu’un d’autre dans la communauté PHP au sens large, c’est quelque chose qui fonctionne toujours.
Cela dit, supposons que vous êtes un développeur basé sur WordPress et que vous cherchez à en savoir plus sur ce qu’est Ray.
Tout d’abord, bien qu’il fournisse un exemple élégant de ce à quoi ressemble votre code lorsqu’il est affiché sur un écran, il offre bien plus.
Notez que lorsque vous utilisez Ray, vous aurez besoin d’outils supplémentaires, que j’aborderai un peu plus dans un instant, mais si vous souhaitez continuer à transférer des informations dans un format utilisant quelque chose de similaire à var_dump, Ray le prend en charge. Cela le rend juste plus joli. 🙂
Deuxièmement, lorsque vous invoquez Ray depuis votre code, il s’assure que vous savez d’où vient l’appel. De cette façon, vous savez exactement quel fichier et quelle ligne vous regardez. Ceci est particulièrement utile lorsque vous avez plusieurs appels.
Troisièmement, vous pouvez réellement suspendre l’exécution de votre code comme vous le faites chaque fois que vous utilisez un débogueur réel. Cela signifie qu’une fois qu’il atteint un certain point dans votre code (et cela est utile si vous remplissez une switchcondition ou une ifcondition ou si vous utilisez, par exemple, une usine en programmation orientée objet et que vous voulez savoir quelle instance de un objet a été instancié), vous pouvez alors arrêter l’exécution et avoir une meilleure idée de ce qui se passe avec votre projet.
Enfin, vous pouvez organiser les types de sortie en différentes couleurs. Cela signifie que si vous touchez une certaine branche dans le code et que vous ne voulez pas toucher cette branche, vous pouvez la classer en rouge. De même, vous pouvez faire de même avec le vert, l’orange, le violet, etc. Cela dépend vraiment de vous et de ce que vous visez en examinant vos données.
Utilisation de Ray dans WordPres
Si vous lisez la documentation pour installer Ray dans WordPress, cela peut sembler un peu intimidant (surtout en fonction de votre expérience avec la CLI, avec Git et avec les plugins indispensables).
Ce qui est bien, c’est qu’il n’est pas nécessaire que ce soit ainsi. Au lieu de cela, vous pouvez récupérer le plugin WordPress Ray à partir du référentiel de plugins (soit depuis le site, soit depuis WordPress en fonction de vos autorisations).
Une fois le plugin installé, vous devriez pouvoir immédiatement commencer à transférer des informations dans Ray.
Utiliser Git et Composer
Si vous choisissez d’utiliser Git et Composer, assurez-vous que ces deux outils sont installés sur votre système, puis procédez comme suit.
Tout d’abord, clonez le dépôt dans votre mu-pluginsrépertoire en exécutant la commande suivante :
$git clone git@github.com:spatie/wordpress-ray
Ensuite, accédez à ce répertoire dans votre terminal et exécutez :
$ composer install
Une fois ce processus terminé, ouvrez wp-config.phpet ajoutez les deux lignes suivantes :
require_once ABSPATH. 'wp-content/mu-plugins/wordpress-ray/wp-ray.php';
define( 'WP_ENVIRONMENT_TYPE', 'local' );
Après cela, vous pouvez commencer à utiliser la rayfonction dans votre code. Par exemple, j’ai la ligne de code suivante exécutée dans un modèle que j’utilise comme démo pour cet article :
<?php ray( wp_get_current_user() ); ?>
Ensuite, chaque fois que cette page est chargée, l’application Ray affiche ce qui suit :
Il s’agit évidemment d’une information riche – une information qui peut encore être lue par d’autres moyens – mais de façon beaucoup plus élégante.
Pour la partie 2
Dans la partie 2 de la série, j’expliquerai comment démarrer le débogage du code à l’aide de Ray et pourquoi j’aime utiliser l’application comme un terrain d’entente entre quelque chose comme [var_dump](https://www.php.net/manual/es/function.var-dump.php)et Xdebug.
De plus, je passerai en revue certaines des fonctionnalités spécifiques à WordPress de Ray afin que vous puissiez voir en quoi c’est plus qu’une "jolie façon de vider les variables".
En fin de compte, je pense que Xdebug est toujours quelque chose qui devrait être utilisé, mais Ray est un terrain d’entente beaucoup plus agréable qui fournit de nombreuses fonctionnalités de débogage solides sans avoir besoin du support complet d’un véritable débogueur.