Autorii plugin-urilor WordPress ar trebui să evite confuzia utilizatorilor atunci când denumesc blocurile

Pe 4 mai, echipa de dezvoltare StudioPress a făcut o modificare mică, dar semnificativă, pentru utilizatori, pluginului său Atomic Blocks (acum rebrandat în Genesis Blocks). A eliminat marca „AB” din titlurile blocurilor sale. Această actualizare minoră a schimbat titlurile blocurilor precum AB Accordion și AB Button în Accordion și, respectiv, Button. La suprafață, probabil că această schimbare a părut de mică importanță dezvoltatorilor proiectului. Cu toate acestea, pentru cel puțin un utilizator, a creat o sarcină de lucru masivă.

Cu excepția cazului în care utilizatorii au urmat în mod religios comenzile codului GitHub, ei ar fi ratat această actualizare. Împreună cu alte câteva modificări de cod pentru un bilet aparent fără legătură, echipa a lăsat un mesaj pe care scria „Eliminați „AB” inutil din titlurile blocurilor.”

Modificarea a ajuns în versiunea 2.8.2 a pluginului, care a fost lansată o zi mai târziu.

Problema a fost că nu exista niciun mesaj în jurnalul de modificări care să menționeze acest lucru. Utilizatorii nu aveau nicio indicație că blocurile din plugin erau redenumite. În mod obișnuit, acest lucru nu ar fi mare lucru, deoarece echipa de pluginuri doar a renunțat la prefixul „AB” din titlurile altfel neschimbate. Cu toate acestea, ce se întâmplă când unul dintre titlurile acestor blocuri se potrivește cu un titlu de bloc principal?

Aceasta a fost problema cu care sa întâlnit Marcus Tibesar. Blocul AB Button a devenit brusc blocul Button. Crezând că folosește butonul de bază WordPress, l-a folosit liberal pe tot site-ul său. Aruncă decizia sa de a renunța la plugin după ce StudioPress și-a rebranșat pluginul la Genesis Blocks, a devenit un dezastru de curățat.

„Folosesc blocul Button de luni de zile doar pentru a descoperi că de fapt folosesc blocul de butoane Blocuri atomice!” a scris Tibesar într-un comentariu la postarea de rebranding Atomic Blocks.

Teoretic, ar fi trebuit să actualizeze doar orice blocuri persistente din Blocurile atomice pe care le-a folosit cu bună știință. Dar, a rămas blocat cu blocuri pe care le-a adăugat fără să știe în postările și paginile sale, fără nicio vină a lui.

Acest scenariu special a fost înrăutățit deoarece WordPress 5.4, lansat pe 31 martie, a introdus un nou bloc Buttons (plural). Vechiul bloc Button a fost scos din dispozitivul de inserare normal. Deși nu toate problemele legate de denumirea blocurilor sunt atât de complicate, se ridică totuși întrebarea: cum pot autorii de pluginuri să evite cauzarea acestor tipuri de probleme legate de experiența utilizatorului?

Este ușor să arunci vina asupra StudioPress - și poate că echipa ar putea folosi o mustrare pentru că nu a fost clar în legătură cu schimbarea atunci când a avut loc. Cu toate acestea, acest lucru aduce la iveală câteva lucruri pe care comunitatea mai mare WordPress trebuie să le descopere. Primul este dacă autorii de pluginuri trebuie să utilizeze o schemă de denumire consecventă, prefixată pentru blocurile lor. Al doilea este ce poate face WordPress pentru a ajuta la atenuarea problemelor.

Prefix toate lucrurile

Acesta este o zicală comună în lumea dezvoltării WordPress, nu ? Îndrumările de prefixare și spațierea numelor se aplică în general codului real, care este locul în care apar conflictele. Cu toate acestea, există momente în care prefixarea textului public este justificată.

Și acele momente sunt când pluginurile utilizează un spațiu partajat.

Editorul de blocuri este un astfel de spațiu partajat. Cu tot mai multe pluginuri de bloc care ajung în director, este timpul ca autorii de pluginuri să ia în considerare modul în care schemele de denumire a blocurilor afectează utilizatorii finali. Problema nu se limitează cu siguranță la Atomic/Genesis Blocks. Aceasta a fost o tendință în curs de desfășurare cu mai multe plugin-uri pentru biblioteci de blocuri. Unele se descurcă mai bine decât altele, dar este o problemă de fiecare dată când un utilizator instalează un astfel de plugin.

Cea mai ușoară cale este ca autorii de pluginuri să prefixeze toate blocurile personalizate cu marca companiei lor (de exemplu, butonul AB). Pe de altă parte, nu fiecare bloc împărtășește un titlu cu unul dintre blocurile de bază. De exemplu, un bloc intitulat Carusel de produse poate să nu fie nevoie să se distingă mai mult de alte blocuri. Este puțin probabil ca utilizatorii finali să ruleze mai multe pluginuri de comerț electronic cu blocuri care au același titlu.

„Toate, repetă toate, ar trebui să aibă un prefix”, a spus Tibesar. „Prefixele elimină orice confuzie în ceea ce privește dacă noi, utilizatorii, selectăm un bloc principal sau un bloc terță parte. Cele mai populare plugin-uri apar în partea de sus a listei și este confuz de unde au venit atunci când prefixele sunt absente.”

Cel puțin, blocurile terță parte ar trebui să aibă un prefix dacă titlurile lor se potrivesc cu unul dintre blocurile de bază. Utilizatorii finali nu ar trebui să vadă două blocuri Cover diferite în dispozitivul de inserare, de exemplu. În schimb, ar trebui să vadă Coperta de bază și un al doilea bloc cu titlu unic. Prefixarea este o modalitate ușoară de a face asta. Dar, aș putea trăi cu orice lucru care nu provoacă confuzie utilizatorilor.

Localizarea instanțelor de utilizare a blocurilor

La sfârșitul anului 2019, echipa Gutenberg a lansat primul prototip al unei potențiale zone de gestionare a blocurilor pentru administratorul WordPress. Ecranul Gestionare blocuri din prototip a prezentat o zonă care ar permite utilizatorilor să gestioneze fiecare bloc de pe site-ul lor. Unul dintre cele mai importante informații de pe acest ecran a fost un număr de „Instanțe”, care arăta de câte ori a fost utilizat un bloc. S-a legat în continuare la un ecran cu fiecare postare care avea un anumit bloc.

Unul dintre motivele pentru care această caracteristică este importantă este că le-ar permite utilizatorilor finali să găsească postări pe care ar putea dori să le curețe. Folosind blocul Atomic/Genesis Button ca exemplu, Tibesar ar putea urmări toate acele utilizări vechi și ar putea face orice modificări pe care le dorea.

El a spus că ar saluta cu siguranță această funcție în WordPress. „Utilizatorii noi sunt tentați să se încarce cu miliarde de pluginuri bloc, toate pentru a fi uitate mai târziu. De asemenea, întreținerii ar folosi acest instrument atunci când curăță site-urile defecte. Doar posibilitatea de a vedea o privire de ansamblu asupra blocurilor care au fost folosite acolo , va permite editorilor să reducă numărul de pluginuri bloc instalate pe site-urile lor, mai ales când apar noi pluginuri și tehnologii.”

Deoarece această caracteristică nu este încă în bază, a trebuit să apeleze la pluginul Find My Blocks, care l-a ajutat să identifice 22 de postări și pagini în care a folosit fără să știe blocul Button din Atomic/Genesis Blocks. Pe termen lung, acesta este ceva care trebuie gestionat direct în WordPress. Este puțin probabil să fie ultima dată când un utilizator trebuie să curețe casa și să scape de blocurile vechi.