WordPress插件作者在命名塊時應避免混淆用戶

5月4日,StudioPress開發團隊對其Atomic Blocks插件(現在是 更名為Genesis Blocks)。 它 刪除「 AB」品牌 從其塊標題。 這次較小的更新將諸如AB手風琴和AB Button之類的標題分別更改為Accordion和Button。 從表面上看,此更改對項目的開發人員似乎影響不大。 但是,對於至少一個用戶,它創建了大量的工作量。

除非用戶忠實地遵循GitHub代碼提交,否則他們將錯過此更新。 該團隊在看似無關的票證上疊加了其他幾個代碼更改,並留下一條消息,內容為「從塊標題中刪除不必要的’AB’。」

更改使它成為插件的2.8.2版,該插件在一天後啟動。

問題是更改日誌中沒有消息指出此問題。 用戶沒有跡象表明該插件中的塊已被重命名。 通常,這沒什麼大不了的,因為插件團隊只是從原本不變的標題中刪除了「 AB」前綴。 但是,當那些塊標題之一與核心塊標題匹配時會發生什麼?

那是Marcus Tibesar遇到的問題。 AB Button塊突然變成Button塊。 考慮到他使用的是核心WordPress Button,他在整個網站上都廣泛使用了它。 在StudioPress將其插件更名為Genesis Blocks之後,他決定放棄該插件,清理起來有點麻煩。

「我已經使用Button塊幾個月了,但發現我實際上是在使用Atomic Blocks按鈕塊!」 Tibesar在評論中寫道 在Atomic Blocks品牌重塑職位上。

從理論上講,他應該只需要更新他有意使用的來自原子塊的任何殘留塊。 但是,他陷入了自己不知不覺地在不知不覺中被添加到帖子和頁面中的障礙。

由於3月31日發布的WordPress 5.4引入了新的Buttons(複數)塊,使這種特殊情況變得更糟。 從常規插入器中刪除了舊的單個Button塊。 儘管並不是所有的塊命名問題都那麼令人費解,但它仍然引出一個問題:插件作者如何避免引起這些類型的用戶體驗問題?

向StudioPress推卸責任很容易-團隊可能會使用責罵,以免在更改發生時不清楚更改。 但是,這帶來了更大的WordPress社區需要弄清的幾件事。 首先是插件作者是否需要為其塊使用一致的前綴命名方案。 第二個是WordPress可以做些什麼來幫助緩解問題。

前綴所有事物
WordPress插件作者在命名塊時應避免混淆用戶WordPress插件作者在命名塊時應避免混淆用戶按鈕,按鈕和更多按鈕。

這是WordPress開發界的俗語,對嗎? 前綴和命名間隔準則通常適用於實際代碼,這是發生衝突的地方。 但是,有時需要在面向公眾的文本前面加上前綴。

那時是插件利用共享空間的時候。

塊編輯器就是這樣一種共享空間。 隨著越來越多的塊插件進入目錄,是時候讓插件作者考慮塊命名方案如何影響最終用戶了。 問題當然不限於原子/創世塊。 幾個塊庫插件一直是一種持續的趨勢。 有些人的表現要好於其他人,但是每次用戶安裝這樣的插件時,這都是值得的。

對於插件作者而言,最簡單的方法是在所有自定義塊的前面加上其公司品牌的前綴(例如AB Button)。 另一方面,並​​非每個塊都與一個核心塊共享一個標題。 例如,標題為Product Carousel的區塊可能不需要與其他區塊進一步區分開。 最終用戶不太可能運行具有相同標題的塊的多個電子商務插件。

蒂貝薩爾說:「所有,全部重複,應該有一個前綴。」 「前綴消除了我們在用戶選擇核心塊還是第三方塊方面的任何困惑。 最受歡迎的插件出現在列表的頂部,並且當前綴不存在時,它們從何而來令人困惑。」

至少,如果第三方塊的標題與核心塊之一匹配,則應該使用前綴。 例如,最終用戶不應在塊插入器中看到兩個不同的Cover塊。 相反,他們應該看到核心Cover和第二個唯一標題的塊。 前綴是一種簡單的方法。 但是,我可以忍受不會引起用戶困惑的任何事物。

查找塊使用情況的實例
WordPress插件作者在命名塊時應避免混淆用戶WordPress插件作者在命名塊時應避免混淆用戶「管理塊」屏幕。

在2019年末,古騰堡團隊發布了 第一個原型 WordPress管理員的潛在區塊管理區域。 原型中的「管理塊」屏幕顯示了一個區域,該區域允許用戶管理其站點上的每個塊。 該屏幕上最重要的信息之一是「實例」計數,該計數顯示塊使用的次數。 它進一步鏈接到屏幕,其中每個帖子都有特定的塊。

此功能很重要的原因之一是,它將允許最終用戶找到他們可能想要清理的帖子。 以Atomic / Genesis Button塊為例,Tibesar可以追蹤所有這些舊用途並進行他想要的任何更改。

他說,他絕對歡迎WordPress中的此功能。 「新用戶很想載入成千上萬的塊插件,這些插件以後都會被遺忘。 此外,維護人員在清理損壞的站點時會使用此工具。 只要能夠看到在什麼地方使用了哪些塊的概述,發行商就可以撥回安裝在其站點上的塊插件的數量,特別是在出現新的插件和技術時。

由於此功能尚不具備核心功能,因此他不得不轉向 找到我的塊 插件,幫助他識別了22個帖子和頁面,在不知不覺中使用了Atomic / Genesis Blocks中的Button塊的地方。 從長遠來看,這是需要直接在WordPress中處理的事情。 這不太可能是用戶最後一次需要打掃房屋並清除舊磚塊。

像這樣:

喜歡載入中……

資源

相關文章