Gli autori dei plugin di WordPress dovrebbero evitare di confondere gli utenti durante la denominazione dei blocchi

Il 4 maggio, il team di sviluppo di StudioPress ha apportato una piccola ma significativa modifica rivolta agli utenti al suo plug-in Atomic Blocks (ora rinominato Genesis Blocks). Ha rimosso il marchio "AB" dai suoi titoli di blocco. Questo aggiornamento minore ha cambiato i titoli dei blocchi come AB Accordion e AB Button rispettivamente in Accordion e Button. In apparenza, questo cambiamento probabilmente sembrava di poca importanza per gli sviluppatori del progetto. Tuttavia, per almeno un utente, ha creato un enorme carico di lavoro.

A meno che gli utenti non abbiano seguito religiosamente i commit del codice GitHub, avrebbero perso questo aggiornamento. Insieme a molte altre modifiche al codice per un ticket apparentemente non correlato, il team ha lasciato un messaggio che diceva: "Rimuovi 'AB' non necessari dai titoli dei blocchi".

La modifica è arrivata alla versione 2.8.2 del plugin, che è stata lanciata il giorno dopo.

Il problema era che non c'era alcun messaggio nel registro delle modifiche che lo annotasse. Gli utenti non avevano alcuna indicazione che i blocchi del plug-in fossero stati rinominati. In genere, questo non sarebbe un grosso problema poiché il team del plugin aveva semplicemente eliminato il prefisso "AB" dai titoli altrimenti invariati. Tuttavia, cosa succede quando i titoli di uno di quei blocchi corrispondono a un titolo di blocco principale?

Questo è stato il problema in cui si è imbattuto Marco Tibesar. Il blocco AB Button è diventato improvvisamente il blocco Button. Pensando di utilizzare il pulsante principale di WordPress, ne ha fatto un uso generoso in tutto il suo sito. Aggiungi la sua decisione di abbandonare il plug-in dopo che StudioPress ha rinominato il suo plug-in in Genesis Blocks, è diventato un po' un disastro ripulire.

"Uso il blocco Button da mesi ormai solo per scoprire che sto effettivamente utilizzando il blocco pulsanti Atomic Blocks!" ha scritto Tibesar in un commento al post sul rebranding di Atomic Blocks.

In teoria, avrebbe dovuto aggiornare solo i blocchi persistenti di Atomic Blocks che aveva usato consapevolmente. Ma era bloccato con blocchi che aveva inconsapevolmente aggiunto ai suoi post e alle sue pagine non per colpa sua.

Questo particolare scenario è stato aggravato dal fatto che WordPress 5.4, rilasciato il 31 marzo, ha introdotto un nuovo blocco Pulsanti (plurale). Il vecchio blocco singolo Button è stato rimosso dal normale inseritore. Sebbene non tutti i problemi di denominazione dei blocchi siano così contorti, pone comunque la domanda: come possono gli autori di plug-in evitare di causare questo tipo di problemi di esperienza utente?

È facile dare la colpa a StudioPress e il team potrebbe forse usare un rimprovero per non essere chiaro sul cambiamento quando è avvenuto. Tuttavia, questo porta alla luce un paio di cose che la grande comunità di WordPress deve capire. Il primo è se gli autori di plugin devono utilizzare uno schema di denominazione coerente e prefissato per i loro blocchi. Il secondo è cosa può fare WordPress per ridurre i problemi.

Prefisso tutte le cose

Questo è il detto comune nel mondo dello sviluppo di WordPress, giusto ? Le linee guida per il prefisso e lo spazio dei nomi si applicano generalmente al codice effettivo, che è il punto in cui sorgono i conflitti. Tuttavia, ci sono momenti in cui è giustificato anteporre il testo rivolto al pubblico.

E quei tempi sono quando i plugin utilizzano uno spazio condiviso.

L'editor di blocchi è uno di questi spazi condivisi. Con sempre più plug-in di blocco che arrivano nella directory, è tempo che gli autori di plug-in considerino in che modo gli schemi di denominazione dei blocchi influiscono sugli utenti finali. La questione non è certamente limitata ai Blocchi Atomici/Genesi. Questa è stata una tendenza in corso con diversi plug-in di librerie di blocchi. Alcuni fanno meglio di altri, ma ogni volta che un utente installa un plug-in di questo tipo è un problema.

Il percorso più semplice è che gli autori di plug-in antepongano semplicemente a tutti i blocchi personalizzati il ​​marchio dell'azienda (ad es. Pulsante AB). D'altra parte, non tutti i blocchi condividono un titolo con uno dei blocchi principali. Ad esempio, un blocco intitolato Product Carousel potrebbe non aver bisogno di distinguersi ulteriormente dagli altri blocchi. È improbabile che gli utenti finali eseguano più plug-in di eCommerce con blocchi che condividono lo stesso titolo.

"Tutto, ripeti tutto, dovrebbe avere un prefisso", ha detto Tibesar. “I prefissi eliminano qualsiasi confusione sul fatto che noi utenti stiamo selezionando un blocco principale o un blocco di terze parti. I plug-in più popolari appaiono in cima all'elenco ed è confuso da dove provengano quando i prefissi sono assenti."

Per lo meno, i blocchi di terze parti dovrebbero avere un prefisso se i loro titoli corrispondono a uno dei blocchi principali. Ad esempio, gli utenti finali non dovrebbero vedere due diversi blocchi di copertura nell'inseritore di blocchi. Invece, dovrebbero vedere la copertina principale e un secondo blocco dal titolo univoco. Il prefisso è un modo semplice per farlo. Ma potrei convivere con qualsiasi cosa che non causi confusione nell'utente.

Individuazione delle istanze di utilizzo dei blocchi

Alla fine del 2019, il team di Gutenberg ha rilasciato il primo prototipo di una potenziale area di gestione dei blocchi per l'amministratore di WordPress. La schermata Gestisci blocchi del prototipo mostrava un'area che avrebbe consentito agli utenti di gestire ogni blocco sul proprio sito. Una delle informazioni più importanti su questa schermata era il conteggio delle "Istanze", che mostrava il numero di volte in cui un blocco era in uso. Si collegava ulteriormente a una schermata con ogni post che aveva un blocco particolare.

Uno dei motivi per cui questa funzione è importante è che consentirebbe agli utenti finali di individuare i post che potrebbero voler ripulire. Usando il blocco Atomic/Genesis Button come esempio, Tibesar poteva rintracciare tutti quei vecchi usi e apportare le modifiche che voleva.

Ha detto che apprezzerebbe assolutamente questa funzione in WordPress. “I nuovi utenti sono tentati di caricare miliardi di plug-in di blocco, tutti da dimenticare in seguito. Inoltre, i manutentori userebbero questo strumento per ripulire i siti danneggiati. Il solo fatto di poter vedere una panoramica di quali blocchi sono stati utilizzati e dove , consentirà agli editori di ridurre il numero di plug-in di blocchi installati sui loro siti, soprattutto quando emergono nuovi plug-in e tecnologie".

Poiché questa funzionalità non è ancora nel nucleo, ha dovuto rivolgersi al plug-in Trova i miei blocchi, che lo ha aiutato a identificare 22 post e pagine in cui aveva inconsapevolmente utilizzato il blocco Button di Atomic/Genesis Blocks. A lungo termine, questo è qualcosa che deve essere gestito direttamente in WordPress. È improbabile che sia l'ultima volta che un utente ha bisogno di pulire casa e sbarazzarsi di vecchi blocchi.