开发插件的最佳实践
避免命名冲突
当您的插件对变量,函数或类使用相同的名称作为另一个插件时,会发生命名冲突。
幸运的是,您可以使用以下方法避免命名冲突。
程序性
默认情况下,所有变量,函数和类都在全局命名空间中定义,这意味着您的插件可以覆盖由另一个插件设置的变量,函数和类,反之亦然。在函数或类中定义的变量不受此影响。
前缀一切
所有变量,函数和类都应以唯一标识符为前缀。前缀可防止其他插件覆盖您的变量并意外调用您的函数和类。它也会阻止你做同样的事情。
检查现有实现
PHP提供了许多函数来验证变量,函数,类和常量的存在。如果实体存在,所有这些都将返回true。
- 变量: isset() (包括数组,对象等)
- 函数: function_exists()
- 类: class_exists()
- 常量:defined()
OOP面向对象
解决命名冲突问题的一种更简单的方法是使用类来获取插件的代码。
您仍然需要检查是否已经使用了您想要的类的名称,但其余的将由PHP处理。
示例:
1 | <?php |
目录结构:
1 | /plugin-name |
条件加载
将管理代码与公共代码分开是有帮助的。使用条件is_admin()。
示例:1
2
3
4
5<?php
if ( is_admin() ) {
// we are in admin mode
require_once( dirname( __FILE__ ) . '/admin/plugin-name-admin.php' );
}
文件结构参考
参考模板
对于您编写的每个新插件,您可能希望从样板开始,而不是从头开始。使用样板的一个优点是在您自己的插件之间保持一致。如果使用他们熟悉的样板,使用模板也可以让其他人更容易为您的代码做出贡献。
这些也可作为不同但可比较的架构的进一步示例。