Comment aider au débogage des extensions WordPress

Les développeurs de JoomUnited travaillent toujours pour que vos plugins fonctionnent de la manière la plus optimale possible. Bien sûr, dans certains cas, un type de défaillance peut survenir, par exemple une incompatibilité générée par un plugin tiers. Et que voulons-nous lorsqu’ce type de défaillances se produit ? Bien sûr, qu’elles soient résolues rapidement ...    

Dans cet article, nous allons vous apprendre comment fournir les bonnes informations au développeur afin qu'il puisse comprendre et résoudre rapidement l'erreur. Cet article sera divisé en 3 étapes que nous allons suivre pour donner les bonnes informations à un développeur lorsqu'un problème survient :

• Activer le journal de débogage
• Installez l'extension de dépannage
• Vérifiez les erreurs JavaScript

Activer le système de débogage et de journalisation de WordPress

Tout d'abord, nous devons savoir ce qu'est WP_DEBUG ; comme nous pouvons le voir sur Wikipédia, « WP_DEBUG est une PHP constante (une variable globale permanente) qui peut être utilisée pour déclencher le mode « debug » dans tout WordPress. Elle est supposée être false par défaut et est généralement définie sur true dans le fichier wp-config.php sur les copies de développement de WordPress. »

Comme nous pouvons le voir, WP_DEBUG est une constante qui est par défaut désactivée mais nous pouvons l' activer à des fins de débogage temporaire. 

En plus de cela, il existe une autre constante PHP appelée WP_DEBUG_LOG qui nous aidera à créer automatiquement un fichier texte contenant toutes les erreurs de vos extensions, et c'est ce que nous allons envoyer aux développeurs.  

Nous allons vous montrer comment l'activer exactement et à quoi cela ressemblera en cas d'erreur avec votre extension, WP Meta SEO sera utilisé pour cet exemple, mais vous pouvez suivre les mêmes étapes pour toutes nos extensions. Dans ce cas, nous avons un problème avec WP Meta SEO, cela pourrait être n'importe quel problème, donc ce que nous allons faire est d'ouvrir le fichier wp-config.php , cela peut être fait avec votre logiciel d'édition de texte préféré, avec Notepad, Visual Studio Code, Brackets par exemple, il suffit d'ouvrir wp-config.php.

Le fichier se trouve à la racine de votre serveur, là où votre site WordPress est installé.

Ouvrez-le avec l'éditeur de texte puis appuyez sur CTRL + F ou cliquez sur Édition > Rechercher… vous verrez une boîte dans laquelle vous pouvez saisir le mot que vous allez rechercher, dans ce cas, nous allons saisir « WP_DEBUG » et appuyez sur Entrée jusqu'à trouver :
« define( 'WP_DEBUG', false ) »

Maintenant que nous sommes sur cette ligne, supprimez le « false » et saisissez true, cliquez sur Entrée et à la ligne suivante, copiez define( 'WP_DEBUG_LOG', true ); puis enregistrez le fichier ; il devrait ressembler à l'image suivante.

Si ces deux lignes sont modifiées, un fichier appelé « debug.php » apparaîtra dans /wp-content/

Et voilà… nous avons terminé la première étape, c’est l’un des fichiers dont nos développeurs auront besoin pour accélérer le processus de résolution de votre problème. Toutes les erreurs seront surveillées et écrites dans ce même fichier texte.

Installez l'extension de dépannage WordPress

Health Check & Troubleshooting est un plugin qui vous permet d'effectuer une vérification des conflits sans affecter les visiteurs normaux de votre site. Il est vraiment simple à utiliser et à installer. Nous allons encore utiliser WP Meta SEO pour cet exemple. Suivez ces étapes pour installer et lancer une vérification des conflits avec Health Check & Troubleshooting :  

• Connectez-vous à votre site WordPress, vous accéderez au tableau de bord de votre site
• Cliquez sur « Plugins », dans la section de gauche de votre page
• Cliquez sur « Ajouter »
• Saisissez « Health Check & Troubleshooting » dans la barre de recherche, comme indiqué ci-dessous

• Cliquez sur “Installer maintenant”, la liste des extensions se chargera automatiquement, recherchez celle qui convient et cliquez sur “Installer maintenant” puis sur “Activer”

• Cliquez sur « Santé du site », dans le menu de gauche se trouve une section appelée « Outils » Cliquez dessus, puis sur « Santé du site »

• Cliquez sur l'onglet « Dépannage » , lisez les informations d'avertissement, puis cliquez sur « Entrer en mode dépannage » 

Le mode de dépannage désactive automatiquement toutes les extensions et bascule vers un thème par défaut. Le mode de dépannage n'affecte pas les visiteurs normaux de votre site.  

• Reproduisez le problème que vous rencontriez

Dans l’environnement par défaut, sans aucun plugin actif et avec un thème par défaut, si le problème se produit, cela signifie que notre plugin n’est pas à l’origine du comportement inattendu.

• Cliquez sur « Extensions » > « Extensions installées »

  Le menu « Plugins » se développera en vous offrant des options supplémentaires. Cliquez sur « Installed Plugins »

• Cliquez sur « Activer pendant le dépannage » à côté de WP Meta SEO

• Reproduisez le problème que vous rencontriez avec uniquement WP Meta SEO actif et un thème par défaut ; si le problème se produit, il est causé par notre extension.

C'est en quelque sorte une bonne nouvelle, car vous avez déjà identifié une partie du problème. Il faut maintenant que le développeur se connecte à votre site et corrige le problème avant que nous publiions une nouvelle version ! Sinon, répétez les étapes pour activer l'extension désactivée suivante avec laquelle vous parvenez à reproduire l'erreur.

Vérification et débogage des erreurs JavaScript dans les extensions WordPress

Nous allons rechercher les erreurs Javascript avec la console Chrome ou Firefox. Selon votre navigateur, son nom est légèrement différent, mais en suivant Chrome et FireFox, nous l'appellerons la « Console ». Pour ouvrir la console, suivez simplement ces étapes :  

• Clic droit sur inspecter, sur le frontend dans n'importe quelle partie du site

• Sélectionnez console, cela ouvrira les outils de développement sur le côté droit de la page, cliquez sur « Console »

Vérifiez les erreurs, avec la console ouverte, reproduisez l'erreur que vous rencontriez et jetez un œil à la console, les erreurs sont des textes rouges qui décrivent où se situe le conflit JavaScript

Si vous avez trouvé une erreur JavaScript, veuillez prendre une capture d'écran de la version développée de l'erreur pour l'inclure dans votre ticket/message.

Envoyer / Partager votre rapport de problème

Maintenant que vous disposez de toutes ces informations, vous aiderez le développeur à accélérer le processus ; il vous suffit de rassembler toutes les informations que vous avez collectées et de les ajouter à votre ticket/message. Rappelons-le, les éléments sont :  

• debug.log
• Notez les extensions qui causent des conflits
• Une capture de la console JavaScript avec l'erreur

Si vous suivez ces étapes et nous envoyez les informations correctes, le développeur pourra effectuer un débogage plus rapide et nous vous remercions beaucoup par avance :)    

Créer et partager un nouveau compte utilisateur WordPress à des fins de support

Créer un nouvel utilisateur administrateur est parfois un moyen rapide de montrer à l'équipe d'assistance la nature de votre problème. Avant de commencer ce processus, un petit rappel :

• Nous ne conservons pas les anciens identifiants une fois le problème résolu (pour des raisons de sécurité)
• Nous recommandons de supprimer les comptes utilisateurs administrateurs créés à des fins de support
• Toutes les informations partagées avec notre équipe sont sécurisées et resteront confidentielles

Pour créer un nouvel utilisateur, connectez-vous d'abord à votre site d'administration. Après vous être connecté avec succès, vous êtes sur le tableau de bord WordPress.

Ensuite, vous devez vous rendre dans le menu de gauche Menu > Utilisateurs.

Ensuite, accédez à l'écran supérieur, cliquez sur le bouton Ajouter ou déplacez-vous vers le bouton Ajouter dans le menu de gauche.

Ensuite, le formulaire Ajouter un nouvel utilisateur apparaîtra sur votre écran. Il y a 2 champs obligatoires à remplir : Nom d'utilisateur, E-mail.

Au niveau du champ Mot de passe , vous pouvez utiliser un générateur de mot de passe aléatoire ou définir le vôtre. Et vous pouvez cocher l'option Envoyer une notification à l'utilisateur si vous souhaitez envoyer un e-mail au nouvel utilisateur concernant son compte.

Ensuite, vous choisissez un Rôle pour l'utilisateur dans la liste déroulante. Il s'agit d'une étape importante pour définir les autorisations des utilisateurs sur votre site. « Administrateur » est le niveau le plus élevé et il donne à l'utilisateur accès à toutes les fonctionnalités de votre site web. Vous pouvez définir d'autres rôles si vous souhaitez limiter l'accès de vos utilisateurs.

Enfin, cliquez sur le bouton Ajouter un nouvel utilisateur en bas de page. C'est déjà fait, bonne chance !