Penulis Plugin WordPress Harus Menghindari Membingungkan Pengguna Saat Menamai Blok

Pada tanggal 4 Mei, tim pengembangan StudioPress membuat perubahan kecil namun signifikan pada plugin Atomic Blocks (sekarang berganti nama menjadi Genesis Blocks). Itu menghapus branding "AB" dari judul bloknya. Pembaruan kecil ini masing-masing mengubah judul blok seperti AB Accordion dan AB Button menjadi Accordion dan Button. Di permukaan, perubahan ini mungkin tampak seperti konsekuensi kecil bagi para pengembang proyek. Namun, untuk setidaknya satu pengguna, itu menciptakan beban kerja yang sangat besar.

Kecuali jika pengguna secara religius mengikuti komit kode GitHub, mereka akan melewatkan pembaruan ini. Ditumpuk dengan beberapa perubahan kode lain untuk tiket yang tampaknya tidak terkait, tim meninggalkan pesan yang berbunyi, "Hapus 'AB' yang tidak perlu dari judul blok."

Perubahan membuatnya menjadi versi 2.8.2 dari plugin, yang diluncurkan sehari kemudian.

Masalahnya adalah tidak ada pesan di log perubahan yang mencatat hal ini. Pengguna tidak memiliki indikasi bahwa blok dari plugin sedang diganti namanya. Biasanya, ini bukan masalah besar karena tim plugin hanya membuang awalan "AB" dari judul yang tidak diubah. Namun, apa yang terjadi ketika salah satu judul blok tersebut cocok dengan judul blok inti?

Itulah masalah yang dihadapi Marcus Timbesar. Blok Tombol AB tiba-tiba menjadi blok Tombol. Berpikir bahwa dia menggunakan Tombol WordPress inti, dia memanfaatkannya secara bebas di seluruh situsnya. Lemparkan keputusannya untuk menjatuhkan plugin setelah StudioPress mengganti nama pluginnya menjadi Genesis Blocks, itu menjadi sedikit bencana untuk dibersihkan.

“Saya telah menggunakan blok Tombol selama berbulan-bulan sekarang hanya untuk mengetahui bahwa saya sebenarnya menggunakan blok tombol Blok Atom!” tulis Tibesar dalam komentar di postingan rebranding Blok Atom.

Secara teoritis, dia seharusnya hanya perlu memperbarui blok yang tersisa dari Blok Atom yang telah dia gunakan secara sadar. Tapi, dia terjebak dengan blok yang tanpa sadar dia tambahkan ke posting dan halamannya bukan karena kesalahannya sendiri.

Skenario khusus ini menjadi lebih buruk karena WordPress 5.4, dirilis pada 31 Maret, memperkenalkan blok Buttons (jamak) baru. Blok Tombol tunggal yang lama telah dihapus dari penyisipan normal. Meskipun tidak semua masalah penamaan blok begitu berbelit-belit, itu masih menimbulkan pertanyaan: bagaimana penulis plugin dapat menghindari menyebabkan jenis masalah pengalaman pengguna ini?

Sangat mudah untuk menyalahkan StudioPress — dan tim mungkin bisa menggunakan teguran karena tidak jelas tentang perubahan ketika itu terjadi. Namun, ini memunculkan beberapa hal yang perlu diketahui oleh komunitas WordPress yang lebih besar. Yang pertama adalah apakah pembuat plugin perlu menggunakan skema penamaan awalan yang konsisten untuk blok mereka. Yang kedua adalah apa yang dapat dilakukan WordPress untuk membantu mengurangi masalah.

Awalan Semua Hal

Itu adalah pepatah umum di dunia pengembangan WordPress, bukan ? Panduan awalan dan penspasian nama umumnya berlaku untuk kode aktual, di situlah konflik muncul. Namun, ada kalanya awalan teks yang menghadap publik diperlukan.

Dan saat-saat itu adalah ketika plugin menggunakan ruang bersama.

Editor blok adalah salah satu ruang bersama tersebut. Dengan semakin banyak plugin blok yang mendarat di direktori, sudah saatnya penulis plugin mempertimbangkan bagaimana skema penamaan blok memengaruhi pengguna akhir. Masalahnya tentu saja tidak terbatas pada Atomic/Genesis Blocks. Ini telah menjadi tren yang sedang berlangsung dengan beberapa plugin perpustakaan blok. Beberapa melakukan lebih baik daripada yang lain, tetapi itu adalah masalah setiap kali pengguna menginstal plugin semacam itu.

Rute termudah adalah bagi pembuat plugin untuk hanya mengawali semua blok khusus dengan merek perusahaan mereka (mis., Tombol AB). Di sisi lain, tidak setiap blok berbagi judul dengan salah satu blok inti. Misalnya, blok berjudul Product Carousel mungkin tidak perlu membedakan dirinya lebih jauh dari blok lain. Tidak mungkin pengguna akhir menjalankan beberapa plugin eCommerce dengan blok yang memiliki judul yang sama.

“Semua, ulangi semua, harus ada awalan,” kata Tibesar. “Awalan menghilangkan kebingungan apakah kami pengguna memilih blok inti atau blok pihak ketiga. Plugin paling populer muncul di bagian atas daftar, dan membingungkan dari mana asalnya ketika awalan tidak ada.”

Paling tidak, blok pihak ketiga harus memiliki awalan jika judulnya cocok dengan salah satu blok inti. Pengguna akhir seharusnya tidak melihat dua blok Cover yang berbeda di penyisipan blok, misalnya. Sebagai gantinya, mereka akan melihat Sampul inti dan blok kedua dengan judul unik. Awalan adalah cara mudah untuk melakukannya. Tapi, saya bisa hidup dengan apa pun yang tidak menyebabkan kebingungan pengguna.

Menemukan Contoh Penggunaan Blok

Pada akhir 2019, tim Gutenberg merilis prototipe pertama dari area manajemen blok potensial untuk admin WordPress. Layar Kelola Blok dari prototipe memamerkan area yang memungkinkan pengguna mengelola setiap blok di situs mereka. Salah satu informasi penting di layar ini adalah hitungan “Instances”, yang menampilkan berapa kali sebuah blok digunakan. Selanjutnya ditautkan ke layar dengan setiap pos yang memiliki blok tertentu.

Salah satu alasan mengapa fitur ini penting adalah karena memungkinkan pengguna akhir menemukan pos yang mungkin ingin mereka bersihkan. Menggunakan blok Tombol Atom/Genesis sebagai contoh, Tibesar dapat melacak semua penggunaan lama tersebut dan membuat perubahan apa pun yang diinginkannya.

Dia mengatakan dia benar-benar akan menyambut fitur ini di WordPress. “Pengguna baru tergoda untuk memuat jutaan plugin blok yang semuanya akan dilupakan nanti. Selain itu, pengelola akan menggunakan alat ini saat membersihkan situs yang rusak. Hanya dengan melihat ikhtisar tentang blok apa yang digunakan di mana , akan memungkinkan penerbit untuk memanggil kembali jumlah plugin blok yang dipasang di situs mereka, terutama ketika plugin dan teknologi baru muncul.”

Karena fitur ini belum menjadi inti, dia harus beralih ke plugin Find My Blocks, yang membantunya mengidentifikasi 22 posting dan halaman di mana dia tanpa sadar menggunakan blok Button dari Atomic/Genesis Blocks. Dalam jangka panjang, ini adalah sesuatu yang perlu ditangani langsung di WordPress. Ini bukan kali terakhir pengguna perlu membersihkan rumah dan menyingkirkan balok-balok lama.