关于为插件命名文件的建议

时间:2011-11-27 作者:ProfK

根据我读到的一些建议[1],我用我采用的插件前缀仔细地命名了所有插件php文件,在本例中为“wpsm-”。我的所有类文件都有额外的“class”限定符,使其前缀为“wpsm class-”。

现在,在做一些早间家务的时候,我试图将其划分为认真的编码,我意识到只要我的所有php文件都保留在插件文件夹中,就没有理由给它们加前缀,删除前缀实际上可以提高可读性。此外,如果我将所有类文件放在“code”或“class”文件夹中,则不需要额外的“class”前缀。

在我上面描述的上下文中,这个问题的读者对我的命名约定有什么建议?

[1] 专业WordPress插件开发:

“在构建自定义插件时,必须在所有插件前面加上唯一的前缀。这意味着所有插件文件、函数名、变量名以及插件中包含的所有内容。”

2 个回复
最合适的回答,由SO网友:ZweiBlumen 整理而成

当然,没有必要用前缀命名插件文件(尽管一些插件作者喜欢这样做)。我怀疑您阅读的建议是指插件文件中的函数。按照您的建议构造插件文件夹(使用类文件夹)很好。

有关编写插件的更多信息,请参阅此链接:

http://codex.wordpress.org/Writing_a_Plugin

特别是“插件开发建议”一节在结尾处指出:

插件中的所有函数都需要具有与WordPress核心、其他插件和主题中的函数不同的唯一名称。因此,最好在插件的所有函数上使用唯一的函数名前缀。一种更好的可能性是在类中定义插件函数(也需要有唯一的名称)。

SO网友:Johannes Pille

至于插件名称前缀,我非常同意。如果所有文件都保存在插件的文件夹中(为什么不保存?),我认为没有任何理由在每个文件前面加上插件名称。正如你所指出的,它实际上恶化了可读性,而这是我认为它唯一的影响。这些文件可通过其所在的文件夹进行唯一标识。我在插件文件中省略了这个前缀。

当谈到类前缀时,情况就不那么清楚了。同样,我认为你的推理可能是多余的,但就我个人而言,我在OOP插件文件中使用它有两个原因:一是,我喜欢根据插件中包含的文件在插件中扮演的角色来命名插件子文件夹,即我的插件子文件夹通常被命名为包括、模块、管理员等等。现在可能有一些与后端相关的类,这些类进入了admin。插件所必需的类包括用户可能选择或不选择用于模块的组件类。所有这些文件夹也可能包含非面向对象的文件。第二个原因是Naming Conventions Wordpress编码标准。

如果您的插件必须由其他人维护,那么类前缀就有意义了。

此外,该标准还建议文件名使用连字符,而不是下划线。

结束

相关推荐

Integrating plugins in themes

我找不到讨论这个的帖子,所以开始这篇。我目前正在为3.1+开发一个相当复杂的主题,我的意思是,除了样式和常规的前端功能之外,我还在主题的核心包括后端和前端的插件。因此,为了使这一点更有条理,我将其分为三个问题:集成插件是一种常见的做法吗</自动更新主题/插件有什么影响/复杂之处</在不破坏现有功能的情况下,包含每个插件的最佳方式是什么