WordPress Eklenti Yazarları Blokları Adlandırırken Kullanıcıların Kafasını Karıştırmaktan Kaçınmalıdır

4 Mayıs'ta StudioPress geliştirme ekibi, Atomic Blocks eklentisinde (şimdi Genesis Blocks olarak yeniden adlandırıldı) kullanıcıya yönelik küçük ama önemli bir değişiklik yaptı. “AB” markasını blok başlıklarından kaldırdı. Bu küçük güncelleme, AB Accordion ve AB Button gibi blok başlıklarını sırasıyla Accordion ve Button olarak değiştirdi. Yüzeyde, bu değişiklik muhtemelen projedeki geliştiriciler için çok az sonuç gibi görünüyordu. Ancak, en az bir kullanıcı için büyük bir iş yükü yarattı.

Kullanıcılar GitHub kod taahhütlerini dini olarak takip etmedikçe, bu güncellemeyi kaçırmış olacaklardı. Görünüşe göre alakasız bir bilet için birkaç başka kod değişikliğiyle birlikte ekip, "Gereksiz 'AB'yi blok başlıklarından kaldırın" yazan bir mesaj bıraktı.

Değişiklik, bir gün sonra başlatılan eklentinin 2.8.2 sürümüne dönüştürdü.

Sorun, değişiklik günlüğünde bunu belirten bir mesaj olmamasıydı. Kullanıcılar, eklentiden gelen blokların yeniden adlandırıldığına dair hiçbir belirti görmedi. Eklenti ekibi, aksi takdirde değişmeyen başlıklardan yalnızca “AB” önekini çıkarmış olduğundan, bu genellikle önemli olmazdı. Ancak, bu blokların başlıklarından biri bir çekirdek blok başlığıyla eşleştiğinde ne olur?

Marcus Tibesar'ın karşılaştığı sorun buydu. AB Düğme bloğu aniden Düğme bloğu oldu. Temel WordPress Düğmesini kullandığını düşünerek, sitesinde özgürce kullandı. StudioPress, eklentisini Genesis Blocks olarak yeniden adlandırdıktan sonra eklentiyi bırakma kararını verin, temizlemesi biraz felaket oldu.

"Düğme bloğunu aylardır sadece Atomik Bloklar düğme bloğunu kullandığımı keşfetmek için kullanıyorum!" Tibesar, Atomic Blocks marka değişikliği gönderisine yaptığı bir yorumda yazdı.

Teorik olarak, yalnızca bilerek kullandığı Atomik Bloklardan kalan blokları güncellemesi gerekiyordu. Ancak kendi kusuru olmaksızın yazılarına ve sayfalarına farkında olmadan eklediği bloklar arasında kaldı.

Bu özel senaryo, 31 Mart'ta yayınlanan WordPress 5.4'ün yeni bir Düğmeler (çoğul) bloğu tanıtması nedeniyle daha da kötüleştirildi. Eski tek Düğme bloğu, normal yerleştiriciden kaldırıldı. Tüm blok adlandırma sorunları bu kadar karmaşık olmasa da, yine de şu soruyu akla getiriyor: Eklenti yazarları bu tür kullanıcı deneyimi sorunlarına neden olmaktan nasıl kaçınabilir?

Suçu StudioPress'e atmak kolaydır - ve ekip, değişiklik olduğunda net olmadığı için belki de onu azarlayabilir. Ancak bu, daha büyük WordPress topluluğunun çözmesi gereken birkaç şeyi ortaya çıkarır. Birincisi, eklenti yazarlarının blokları için tutarlı, önekli bir adlandırma şeması kullanması gerekip gerekmediğidir. İkincisi, WordPress'in sorunları azaltmaya yardımcı olmak için neler yapabileceğidir.

Her Şeyin Öneki

WordPress geliştirme dünyasındaki yaygın söz budur, değil mi ? Ön ek ve ad alanı yönergeleri genellikle, çakışmaların ortaya çıktığı gerçek kod için geçerlidir. Ancak, halka açık metinlerin ön ekinin gerekli olduğu zamanlar vardır.

Ve o zamanlar, eklentilerin paylaşılan bir alan kullandığı zamanlar.

Blok düzenleyici böyle bir paylaşılan alandır. Gittikçe daha fazla blok eklentinin dizine inmesiyle, eklenti yazarlarının blok adlandırma şemalarının son kullanıcıları nasıl etkilediğini düşünmesinin zamanı geldi. Sorun kesinlikle Atomik/Genesis Blokları ile sınırlı değil. Bu, birkaç blok kitaplık eklentisi ile devam eden bir trend olmuştur. Bazıları diğerlerinden daha iyisini yapar, ancak bir kullanıcı böyle bir eklentiyi her yüklediğinde bu bir şanstır.

Eklenti yazarlarının en kolay yolu, tüm özel blokları şirket markalarıyla (örn. AB Düğmesi) basitçe öneklemeleridir. Öte yandan, her blok çekirdek bloklardan biriyle aynı unvanı paylaşmaz. Örneğin, Product Carousel adlı bir bloğun kendisini diğer bloklardan daha fazla ayırması gerekmeyebilir. Son kullanıcıların aynı başlığı paylaşan bloklarla birden fazla e-Ticaret eklentisi çalıştırması pek olası değildir.

Tibesar, "Tümü, hepsini tekrar et, bir önek olmalı," dedi. “Önekler, biz kullanıcıların bir çekirdek blok mu yoksa üçüncü taraf bir blok mu seçtiğine dair herhangi bir karışıklığı ortadan kaldırıyor. En popüler eklentiler listenin en üstünde yer alır ve ön ekler olmadığında nereden geldikleri kafaları karıştırır.”

Başlıkları çekirdek bloklardan biriyle eşleşiyorsa, en azından üçüncü taraf bloklarının bir öneki olmalıdır. Örneğin, son kullanıcılar blok yerleştiricide iki farklı Kapak bloğu görmemelidir. Bunun yerine, ana Kapağı ve benzersiz başlıklı ikinci bir bloğu görmeleri gerekir. Önekleme bunu yapmanın kolay bir yoludur. Ancak, kullanıcı karışıklığına neden olmayan herhangi bir şeyle yaşayabilirim.

Blok Kullanımı Örneklerini Bulma

2019'un sonlarında Gutenberg ekibi, WordPress yöneticisi için potansiyel bir blok yönetimi alanının ilk prototipini yayınladı. Prototipteki Blokları Yönet ekranı, kullanıcıların sitelerindeki her bloğu yönetmesine izin verecek bir alan sergiledi. Bu ekrandaki en önemli bilgi bitlerinden biri, bir bloğun kaç kez kullanımda olduğunu gösteren bir "Örnek" sayısıydı. Ayrıca, belirli bir bloğu olan her gönderiyle bir ekrana bağlandı.

Bu özelliğin önemli olmasının nedenlerinden biri, son kullanıcıların temizlemek isteyebilecekleri gönderileri bulmasına izin vermesidir. Atomik/Genesis Düğmesi bloğunu örnek olarak kullanan Tibesar, tüm bu eski kullanımların izini sürebilir ve istediği değişiklikleri yapabilirdi.

WordPress'te bu özelliği kesinlikle memnuniyetle karşılayacağını söyledi. “Yeni kullanıcılar, daha sonra unutulmak üzere zilyonlarca blok eklenti yüklemeye meyillidir. Ayrıca, bakım görevlileri, bozuk siteleri temizlerken bu aracı kullanır. Sadece hangi blokların nerede kullanıldığına dair bir genel bakışı görebilmek, yayıncıların, özellikle yeni eklentiler ve teknolojiler ortaya çıktığında, sitelerinde kurulu blok eklentilerinin sayısını geri çevirmelerine izin verecektir.”

Bu özellik henüz çekirdekte olmadığı için, Atomic/Genesis Blocks'un Button bloğunu bilmeden kullandığı 22 gönderi ve sayfayı tanımlamasına yardımcı olan Find My Blocks eklentisine başvurmak zorunda kaldı. Uzun vadede, bu doğrudan WordPress'te ele alınması gereken bir şeydir. Bir kullanıcının evi temizlemesi ve eski bloklardan kurtulması gereken son sefer olması pek olası değildir.