Autorzy wtyczek WordPress powinni unikać dezorientowania użytkowników podczas nazywania bloków

4 maja zespół programistów StudioPress dokonał niewielkiej, ale znaczącej zmiany skierowanej do użytkownika we wtyczce Atomic Blocks (obecnie przemianowanej na Genesis Blocks). Usunął markę „AB” z tytułów bloków. Ta niewielka aktualizacja zmieniła tytuły bloków, takie jak AB Accordion i AB Button, odpowiednio na Accordion i Button. Na pozór ta zmiana prawdopodobnie wydawała się mało istotna dla twórców projektu. Jednak dla co najmniej jednego użytkownika spowodowało to ogromne obciążenie pracą.

O ile użytkownicy nie przestrzegaliby religijnie zatwierdzeń kodu GitHub, przeoczyliby tę aktualizację. W połączeniu z kilkoma innymi zmianami w kodzie dla pozornie niepowiązanego biletu, zespół zostawił wiadomość, która brzmiała: „Usuń niepotrzebne „AB” z tytułów bloków”.

Zmiana przekształciła go w wersję 2.8.2 wtyczki, która została uruchomiona dzień później.

Problem polegał na tym, że w dzienniku zmian nie było komunikatu, który to odnotował. Użytkownicy nic nie wskazywali na to, że nazwy bloków z wtyczki są zmieniane. Zazwyczaj nie byłoby to wielkim problemem, ponieważ zespół wtyczek po prostu usunął przedrostek „AB” z niezmienionych tytułów. Co się jednak dzieje, gdy jeden z tytułów tych bloków pasuje do tytułu bloku podstawowego?

To był problem, na który wpadł Marcus Tibesar. Blok przycisku AB nagle stał się blokiem przycisku. Myśląc, że korzysta z głównego przycisku WordPressa, swobodnie z niego korzystał w całej swojej witrynie. Wrzuć swoją decyzję o porzuceniu wtyczki po tym, jak StudioPress zmienił nazwę wtyczki na Genesis Blocks, posprzątanie stało się trochę katastrofą.

„Używam bloku przycisku od miesięcy tylko po to, aby odkryć, że faktycznie używam bloku przycisku Bloki atomowe!” napisał Tibesar w komentarzu pod postem o rebrandingu Atomic Blocks.

Teoretycznie powinien był potrzebować zaktualizować tylko te utrzymujące się bloki z bloków atomowych, których świadomie używał. Ale utknął z blokami, które nieświadomie dodał do swoich postów i stron bez własnej winy.

Ten konkretny scenariusz został pogorszony, ponieważ WordPress 5.4, wydany 31 marca, wprowadził nowy blok przycisków (liczba mnoga). Stary blok pojedynczego przycisku został usunięty z normalnego insertera. Chociaż nie wszystkie problemy z nazewnictwem bloków są tak zawiłe, wciąż nasuwa się pytanie: w jaki sposób twórcy wtyczek mogą uniknąć powodowania tego rodzaju problemów z doświadczeniem użytkownika?

Łatwo jest zrzucić winę na StudioPress – a zespół może użyć bełkotu za to, że nie jest jasny co do zmiany, kiedy to się stało. To jednak pokazuje kilka rzeczy, które większa społeczność WordPressa musi rozgryźć. Pierwszym z nich jest to, czy autorzy wtyczek muszą używać spójnego schematu nazewnictwa z przedrostkami dla swoich bloków. Po drugie, co może zrobić WordPress, aby złagodzić problemy.

Przedrostek Wszystkie rzeczy

To jest popularne powiedzenie w świecie programistów WordPress, prawda ? Wytyczne dotyczące przedrostków i przestrzeni nazw zwykle dotyczą samego kodu, w którym pojawiają się konflikty. Jednak zdarza się, że umieszczanie prefiksu w tekście widocznym publicznie jest uzasadnione.

A takie czasy są, kiedy wtyczki wykorzystują wspólną przestrzeń.

Edytor bloków jest jedną z takich wspólnych przestrzeni. Ponieważ coraz więcej wtyczek blokowych trafia do katalogu, nadszedł czas, aby autorzy wtyczek zastanowili się, jak schematy nazewnictwa bloków wpływają na użytkowników końcowych. Problem z pewnością nie ogranicza się do bloków Atomic/Genesis. Jest to stały trend w przypadku kilku wtyczek bibliotek blokowych. Niektóre radzą sobie lepiej niż inne, ale za każdym razem, gdy użytkownik instaluje taką wtyczkę, jest to wywrotka.

Najłatwiejszą drogą dla autorów wtyczek jest poprzedzenie wszystkich niestandardowych bloków nazwą ich firmy (np. AB Button). Z drugiej strony nie każdy blok dzieli tytuł z jednym z głównych bloków. Na przykład blok zatytułowany Karuzela produktów może nie musieć dalej odróżniać się od innych bloków. Jest mało prawdopodobne, aby użytkownicy końcowi korzystali z wielu wtyczek eCommerce z blokami o tym samym tytule.

„Wszystko, powtórz wszystko, powinno mieć przedrostek”, powiedział Tibesar. „Prefiksy eliminują wszelkie nieporozumienia dotyczące tego, czy my, użytkownicy, wybieramy blok podstawowy, czy blok innej firmy. Najpopularniejsze wtyczki pojawiają się na górze listy i jest mylące, ponieważ nie ma prefiksów”.

Przynajmniej bloki stron trzecich powinny mieć prefiks, jeśli ich tytuły pasują do jednego z bloków podstawowych. Użytkownicy końcowi nie powinni na przykład widzieć dwóch różnych bloków okładki w module wstawiania bloków. Zamiast tego powinni zobaczyć podstawową Okładkę i drugi blok o unikalnym tytule. Prefiksy to prosty sposób na zrobienie tego. Ale mógłbym żyć ze wszystkim, co nie powoduje dezorientacji użytkownika.

Lokalizowanie wystąpień użycia bloku

Pod koniec 2019 roku zespół Gutenberga wydał pierwszy prototyp potencjalnego obszaru zarządzania blokami dla administratora WordPressa. Ekran Zarządzaj blokami z prototypu pokazywał obszar, który pozwalałby użytkownikom zarządzać każdym blokiem w ich witrynie. Jedną z ważniejszych informacji na tym ekranie była liczba „instancji”, która wyświetlała, ile razy blok był używany. Dalej łączyło się z ekranem z każdym postem, który miał określony blok.

Jednym z powodów, dla których ta funkcja jest ważna, jest umożliwienie użytkownikom końcowym zlokalizowanie postów, które mogą chcieć wyczyścić. Używając bloku przycisku Atomic/Genesis jako przykładu, Tibesar mógł wyśledzić wszystkie te stare zastosowania i wprowadzić dowolne zmiany.

Powiedział, że z radością powita tę funkcję w WordPressie. „Nowi użytkownicy są kuszeni, aby załadować miliardy wtyczek blokowych, o których później można zapomnieć. Ponadto opiekunowie będą używać tego narzędzia podczas czyszczenia uszkodzonych witryn. Sama możliwość zobaczenia przeglądu tego, jakie bloki zostały użyte, gdzie , pozwoli wydawcom zmniejszyć liczbę wtyczek blokowych zainstalowanych w ich witrynach, zwłaszcza gdy pojawią się nowe wtyczki i technologie”.

Ponieważ ta funkcja nie jest jeszcze w rdzeniu, musiał skorzystać z wtyczki Find My Blocks, która pomogła mu zidentyfikować 22 posty i strony, na których nieświadomie użył bloku przycisku z Atomic/Genesis Blocks. Na dłuższą metę należy to zrobić bezpośrednio w WordPressie. Jest mało prawdopodobne, aby był to ostatni raz, kiedy użytkownik musi posprzątać dom i pozbyć się starych bloków.