WordPress 插件作者在命名块时应避免混淆用户

5 月 4 日,StudioPress 开发团队对其 Atomic Blocks 插件(现在更名为 Genesis Blocks)进行了面向用户的小而重要的更改.它删除了"AB"来自其块标题的品牌.此小更新将块标题(例如 AB Accordion 和 AB Button)分别更改为 Accordion 和 Button.从表面上看,这种变化对项目的开发人员来说似乎没有什么影响.然而,对于至少一个用户来说,它造成了巨大的工作量.

除非用户虔诚地遵循 GitHub 代码提交,否则他们会错过这次更新.与看似无关的工单的其他几个代码更改堆叠在一起,该团队留下了一条消息,上面写着"删除不必要的"AB";来自块标题.”

该更改使其成为插件的 2.8.2 版,该版本在一天后发布.

问题是更改日志中没有消息指出这一点.用户没有迹象表明插件中的块正在被重命名.通常,这没什么大不了的,因为插件团队只是放弃了"AB".来自其他未更改标题的前缀.但是,当这些块之一发生时会发生什么? titles 是否与核心块标题匹配?

这就是 Marcus Tibesar 遇到的问题.AB Button 块突然变成了 Button 块.认为他在使用核心 WordPress 按钮,他在整个网站上自由地使用它.在 StudioPress 将其插件更名为 Genesis Blocks 之后,他决定放弃该插件,清理起来有点灾难.

“我已经使用按钮块几个月了,结果发现我实际上在使用原子块按钮块!” Tibesar 在 Atomic Blocks 品牌重塑帖子的评论中写道.

理论上,他应该只需要更新他有意使用的原子块中的任何延迟块.但是,他被他在不知不觉中添加到他的帖子和页面的块卡住了,这些块不是他自己的错.

这种特殊情况变得更糟,因为 3 月 31 日发布的 WordPress 5.4 引入了一个新的 Buttons(复数)块.旧的单个 Button 块已从普通插入器中移除.虽然并非所有块命名问题都如此复杂,但它仍然引出了一个问题:插件作者如何避免导致这些类型的用户体验问题?

很容易把责任推给 StudioPress —团队可能会因为在变化发生时不清楚变化而使用责骂.然而,这带来了一些更大的 WordPress 社区需要弄清楚的事情.首先是插件作者是否需要为其块使用一致的前缀命名方案.第二个是 WordPress 可以做些什么来帮助缓解问题.

前缀所有的东西

按钮、按钮和更多按钮.

这是 WordPress 开发界的普遍说法,对吗?前缀和命名空间准则通常适用于实际代码,这是发生冲突的地方.但是,有时需要为面向公众的文本添加前缀.

那些时候是插件利用共享空间的时候.

块编辑器就是这样一种共享空间.随着越来越多的块插件登陆目录,插件作者是时候考虑块命名方案如何影响最终用户了.这个问题当然不仅限于原子/创世块.这是几个块库插件的持续趋势.有些比其他的做得更好,但每次用户安装这样的插件时都会折腾.

插件作者最简单的方法是在所有自定义块前加上他们的公司品牌(例如,AB 按钮).另一方面,并​​非每个区块都与其中一个核心区块共享一个标题.例如,标题为 Product Carousel 的块可能不需要与其他块进一步区分.最终用户不太可能运行多个具有相同标题的块的电子商务插件.

“所有,重复所有,应该有前缀,”提贝萨尔说.“前缀消除了我们用户选择的是核心块还是第三方块的任何混淆.最流行的插件出现在列表的顶部,如果没有前缀,它们是从哪里来的,令人困惑.”

至少,如果第三方块的标题与核心块之一匹配,则第三方块应该有一个前缀.例如,最终用户不应在块插入器中看到两个不同的 Cover 块.相反,他们应该看到核心封面和第二个唯一标题的块.前缀是一种简单的方法.但是,我可以接受任何不会引起用户混淆的东西.

定位块使用实例

管理块屏幕.

在 2019 年底,Gutenberg 团队发布了 WordPress 管理员潜在块管理区域的第一个原型.原型中的管理块屏幕展示了一个区域,允许用户管理其站点上的每个块.此屏幕上更重要的信息之一是"实例".计数,显示一个块被使用的次数.它进一步链接到一个屏幕,每个帖子都有一个特定的块.

此功能很重要的原因之一是它允许最终用户找到他们可能想要清理的帖子.以 Atomic/Genesis Button 块为例,Tibesar 可以追踪所有这些旧用途并进行他想要的任何更改.

他说他绝对欢迎 WordPress 中的这个功能.“新用户很想加载无数块插件,这些插件后来都被遗忘了.此外,维护人员在清理损坏的站点时会使用此工具.只需能够查看使用什么块的概览在哪里,发布商就可以回拨安装在其网站上的块插件的数量,尤其是在新的插件和技术出现.”

由于此功能尚未成为核心,他不得不求助于 Find My Blocks 插件,该插件帮助他识别了 22 个帖子和页面,其中他在不知不觉中使用了 Atomic/Genesis Blocks 中的 Button 块.从长远来看,这是需要直接在 WordPress 中处理的事情.这不太可能是用户最后一次需要清理房屋和清除旧块.

VPS1352主机测评网(www.vps1352.com)
本文链接:https://www.vps1352.com/7433.html

8

发表回复