如何为我的插件创建API？

#1 楼

您在插件或主题中提供的API取决于该特定代码的逻辑。可能没有适用于所有情况的指南。
我是使用API​​的多个插件的贡献者，到目前为止，我了解到的是：


直到您真正了解人们如何使用您的代码为止。
发布没有任何API的前两个或三个版本。如果可能的话，没有自定义操作或过滤器，没有公共方法或函数（也没有任何全局变量）。等待用户的请求，但不要添加代码，直到您知道内部代码结构可以长期运行为止。
维护API的向后兼容性非常困难。这可能会阻止在其他地方进行必要的改进。考虑一下WordPress现在无法删除的所有全局变量。那是一个不好的API，而且由于人们已经使用了它，所以我们坚持使用了很多年。


请考虑将您的API与其余代码分开（有关想法，请参见前面的链接） ）。
您的API应该不仅对第三方开发人员有用，而且对您也有用。不必自己添加限制。


吃自己的狗粮。
如果提供自定义钩子，请在代码中使用它们。这将为其他开发人员提供有用的示例，并且您很快就会发现可能的缺陷。
如果WordPress核心内部使用了所谓的Settings API，那么今天我们就不会再出现这种情况了。也许。


以身作则。
在插件中使用WordPress核心API的优秀部分。避免使用匿名对象，常量，全局变量和任何类型的不可预测的代码。


请确保您使用的是一致的命名方案（而不是一团糟），并将所有内容放在自己的命名空间下。


先写文档。稍后发布新的（一部分）API。
为所有内容创建有用的示例。您会惊讶地发现会发现多少孔和冗余。


避免回调地狱。
在事情无法正常工作时（包括不小的脚本和样式表），提供特定的工具来调试API。我已经写了一个有关如何调试AJAX的示例，只是为了说明您在这里的创造力。同样，在发布它们之前，应在文档中对这些工具进行解释。


观察者模式可以替代WordPress的回调范式。这将为第三方开发人员增加障碍，但可能会导致双方都有更好的代码。