使用技巧

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中处理的事情。 这不太可能是用户最后一次需要打扫房屋并清除旧砖块。

像这样:

喜欢加载中……

资源