Le 4 mai, l’équipe de développement de StudioPress a apporté un petit mais significatif changement face à l’utilisateur à son plugin Atomic Blocks (maintenant rebaptisé Genesis Blocks). Il a supprimé la marque « AB » à partir de ses titres de bloc. Cette mise à jour mineure a changé les titres de blocs tels que AB Accordion et AB Button en Accordion et Button, respectivement. En apparence, ce changement a probablement semblé sans conséquence pour les développeurs du projet. Cependant, pour au moins un utilisateur, cela a créé une charge de travail massive.

À moins que les utilisateurs n’aient suivi religieusement les engagements du code GitHub, ils auraient manqué cette mise à jour. Empilée avec plusieurs autres modifications de code pour un ticket apparemment sans rapport, l’équipe a laissé un message qui disait: « Supprimez les » AB « inutiles des titres de bloc. »

Le changement en a fait la version 2.8.2 du plugin, qui a été lancé un jour plus tard.

Le problème était qu’il n’y avait aucun message dans le journal des modifications qui notait cela. Les utilisateurs n’avaient aucune indication que les blocs du plugin étaient renommés. En règle générale, ce ne serait pas un gros problème puisque l’équipe du plugin avait simplement supprimé le préfixe «AB» des titres autrement inchangés. Cependant, que se passe-t-il lorsqu’un de ces titres de blocs correspond à un titre de bloc principal?

C’est le problème que Marcus Tibesar a rencontré. Le bloc AB Button est soudainement devenu le bloc Button. Pensant qu’il utilisait le bouton WordPress principal, il en a fait un usage libéral sur tout son site. Jeter dans sa décision d’abandonner le plugin après que StudioPress a renommé son plugin en Genesis Blocks, c’est devenu un peu un désastre à nettoyer.

« J’utilise le bloc Button depuis des mois maintenant pour découvrir que j’utilise réellement le bloc de boutons Atomic Blocks! » a écrit Tibesar dans un commentaire sur le poste de changement de marque Atomic Blocks.

Théoriquement, il aurait dû ne mettre à jour que les blocs persistants des blocs atomiques qu’il avait sciemment utilisés. Mais, il était coincé avec des blocs qu’il avait sans le savoir ajoutés à ses messages et pages sans que ce soit de sa faute.

Ce scénario particulier a été aggravé car WordPress 5.4, sorti le 31 mars, a introduit un nouveau bloc Buttons (pluriel). L’ancien bloc Button unique a été retiré de l’inséreuse normale. Bien que tous les problèmes de dénomination de bloc ne soient pas si compliqués, cela pose toujours la question: comment les auteurs de plugins peuvent-ils éviter de causer ces types de problèmes d’expérience utilisateur?

Il est facile de rejeter le blâme sur StudioPress – et l’équipe pourrait peut-être utiliser une réprimande pour ne pas être claire sur le changement quand il s’est produit. Cependant, cela apporte quelques éléments que la plus grande communauté WordPress doit comprendre. La première est de savoir si les auteurs de plugins doivent utiliser un schéma de dénomination cohérent et préfixé pour leurs blocs. Le deuxième est ce que WordPress peut faire pour aider à atténuer les problèmes.

Préfixer toutes les choses

Capture d'écran de l'ajout de blocs de boutons de plusieurs plugins à l'éditeur.
Boutons, boutons et autres boutons.

C’est le dicton commun dans le monde du développement WordPress, droite? Les directives de préfixage et d’espacement des noms s’appliquent généralement au code réel, là où les conflits surviennent. Cependant, il y a des moments où le préfixe de texte public est justifié.

Et ces moments sont ceux où les plugins utilisent un espace partagé.

L’éditeur de blocs est l’un de ces espaces partagés. Avec de plus en plus de plugins de bloc qui arrivent dans le répertoire, il est temps que les auteurs de plugins considèrent comment les schémas de dénomination de bloc affectent les utilisateurs finaux. Le problème ne se limite certainement pas aux blocs Atomic / Genesis. Cela a été une tendance continue avec plusieurs plugins de bibliothèque de blocs. Certains font mieux que d’autres, mais c’est un jeu d’enfant chaque fois qu’un utilisateur installe un tel plugin.

Le moyen le plus simple est pour les auteurs de plugins de simplement préfixer tous les blocs personnalisés avec la marque de leur entreprise (par exemple, bouton AB). D’un autre côté, tous les blocs ne partagent pas un titre avec l’un des blocs principaux. Par exemple, un bloc intitulé Carrousel de produits peut ne pas avoir besoin de se distinguer davantage des autres blocs. Il est peu probable que les utilisateurs finaux exécutent plusieurs plugins de commerce électronique avec des blocs qui partagent le même titre.

« Tout, répétez tout, devrait avoir un préfixe », a déclaré Tibesar. «Les préfixes éliminent toute confusion quant à savoir si nous, utilisateurs, sélectionnons un bloc principal ou un bloc tiers. Les plugins les plus populaires apparaissent en haut de la liste et il est difficile de savoir d’où ils proviennent lorsque les préfixes sont absents. « 

À tout le moins, les blocs tiers devraient avoir un préfixe si leurs titres correspondent à l’un des blocs principaux. Les utilisateurs finaux ne doivent pas voir deux blocs Cover différents dans l’inséreuse de blocs, par exemple. Au lieu de cela, ils devraient voir la couverture principale et un deuxième bloc au titre unique. Le préfixage est un moyen simple de le faire. Mais je pourrais vivre avec tout ce qui ne crée pas de confusion chez les utilisateurs.

Localisation des instances d’utilisation des blocs

Capture d'écran du prototype d'écran Manage Blocks pour WordPress.
Écran Gérer les blocs.

Fin 2019, l’équipe de Gutenberg a publié le premier prototype d’une zone de gestion de bloc potentielle pour l’administrateur WordPress. L’écran Gérer les blocs du prototype présentait une zone qui permettrait aux utilisateurs de gérer chaque bloc sur leur site. L’un des éléments d’information les plus importants sur cet écran était le décompte des «instances», qui affichait le nombre de fois qu’un bloc était utilisé. Il était en outre lié à un écran avec chaque message contenant un blocage particulier.

L’une des raisons pour lesquelles cette fonctionnalité est importante est qu’elle permettrait aux utilisateurs finaux de localiser les publications qu’ils souhaiteraient peut-être nettoyer. En utilisant le bloc Atomic / Genesis Button comme exemple, Tibesar pouvait retrouver toutes ces anciennes utilisations et apporter les modifications souhaitées.

Il a dit qu’il apprécierait absolument cette fonctionnalité dans WordPress. «Les nouveaux utilisateurs sont tentés de charger des millions de plugins de bloc, tous oubliés plus tard. De plus, les responsables de la maintenance utiliseraient cet outil pour nettoyer les sites endommagés. Pouvoir simplement voir un aperçu de quelle des blocs ont été utilisés , permettra aux éditeurs de recomposer le nombre de plugins de blocage installés sur leurs sites, en particulier lorsque de nouveaux plugins et technologies émergent. »

Parce que cette fonctionnalité n’est pas encore dans le noyau, il a dû se tourner vers le Trouver mes blocs plugin, qui l’a aidé à identifier 22 articles et pages où il avait utilisé sans le savoir le bloc Button des blocs Atomic / Genesis. Sur le long terme, c’est quelque chose qui doit être géré directement dans WordPress. Il est peu probable que ce soit la dernière fois qu’un utilisateur doit nettoyer sa maison et se débarrasser des vieux blocs.


Source link