跳转到主要内容

主插件文件，然后是一个或多个类文件

下载网址：https://github.com/DevinVinson/WordPress-Plugin-Boilerplate

可以通过下列网址自动生成结构：https://wppb.me/

WordPress 插件样板

用于构建高质量 WordPress 插件的标准化、有组织、面向对象的基础。

内容

WordPress 插件样板包含以下文件：

  • .gitignore。用于从存储库中排除某些文件。
  • CHANGELOG.md。核心项目的更改列表。
  • README.md。您当前正在阅读的文件。
  • 包含源代码的目录plugin-name- 完全可执行的 WordPress 插件。

特征

  • 该样板基于插件 API、编码标准和文档标准。
  • 所有类、函数和变量都已记录下来，以便您知道需要更改哪些内容。
  • Boilerplate 使用严格的文件组织方案，该方案与 WordPress 插件存储库结构相对应，并且可以轻松组织组成插件的文件。
  • 该项目包括一个.pot文件作为国际化的起点。

安装

Boilerplate 可以直接“按原样”安装到您的插件文件夹中。您将需要重命名它及其内部的类以满足您的需要。例如，如果您的插件名为“example-me”，则：

  • 将文件重命名plugin-name为example-me
  • 更改plugin_name为example_me
  • 更改plugin-name为example-me
  • 更改Plugin_Name为Example_Me
  • 更改PLUGIN_NAME_为EXAMPLE_ME_

此时激活插件是安全的。由于样板没有真正的功能，因此在编写代码之前不会添加菜单项、元框或自定义帖子类型。

WordPress.org 准备

此版本样板的最初发布包括在 WordPress.org 上使用插件所需的文件夹结构。该文件夹结构已移至其自己的存储库：https ://github.com/DevinVinson/Plugin-Directory-Boilerplate

推荐工具

国际化工具

WordPress 插件样板使用变量来存储在整个样板中国际化字符串时使用的文本域。要利用此方法，建议使用一些工具来提供正确的可翻译文件：

上述任何工具都应该为您提供适当的工具来国际化插件。

许可证

WordPress 插件样板根据 GPL v2 或更高版本获得许可。

该程序是免费软件；您可以根据自由软件基金会发布的 GNU 通用公共许可证第 2 版的条款重新分发和/或修改它。

分发此程序的目的是希望它有用，但不提供任何保证；甚至没有适销性或特定用途适用性的默示保证。有关更多详细信息，请参阅 GNU 通用公共许可证。

您应该随该程序一起收到 GNU 通用公共许可证的副本；如果没有，请写信给 Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

许可证的副本包含在插件目录的根目录中。该文件名为LICENSE.

重要笔记

许可

WordPress 插件样板已根据 GPL v2 或更高版本获得许可；但是，如果您选择使用与 v2 不兼容的第三方代码，那么您可能需要改用与 GPL v3 兼容的代码。

作为参考，这里的讨论涵盖了Bootstrap使用的 Apache 2.0 许可证。

包括

请注意，如果您包含自己的类或第三方库，则所述文件可能位于三个位置：

  • plugin-name/includes是管理区域和网站面向公众的部分之间共享功能的地方
  • plugin-name/admin适用于所有特定于管理员的功能
  • plugin-name/public适用于所有面向公众的功能

请注意，以前版本的样板不包含该类Plugin_Name_Loader，但该类用于向 WordPress 注册所有过滤器和操作。

提供的示例代码展示了如何向 Loader 类注册您的钩子。

其他功能怎么样？

WordPress 插件样板的早期版本包含对许多不同项目的支持，例如GitHub Updater。

这些工具不是这个样板的核心部分，因为我认为它们是对样板的补充、分叉或其他贡献。

使用 Grunt、Composer 等工具也是如此。这些都是很棒的工具，但并不是每个人都使用它们。为了保持核心Boilerplate尽可能轻，这些功能已被删除，并将在其他版本中引入，并将在项目主页上列出和维护。

无评论
回到顶部