README

该项目已被弃用，转而使用 jaxion-bootstrap。该项目仍在开发中，但这里的大多数工具/实现都将包含在内。如果您有任何问题，请通过jamesorodig@gmail.com发送电子邮件给我。

wppb-mod

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

要求

wppb-mod 包含以下工具要求

1. PHP 5.3+
   • 注意：WordPress 兼容回退到 5.2，因此并非所有用户都能使用此插件。
2. Composer，用于后端库。
3. npm，用于构建工具。
4. Bower，用于前端库。
5. Gulp，用于项目构建

功能

• 可以使用 composer create-project maadhattah/wppb-mod <目标目录> 生成新的插件。
  • 需要一个扁平化的结构才能正常工作。
• 脚手架基于 插件 API、编码标准 和 文档标准。
• 所有类、函数和变量都有文档，以便您知道需要更改什么。
• 应用程序加载到单例中，以便第三方开发者可以操作钩子。
• 项目包含一个 .pot 文件作为国际化的起点。
• 单元测试已构建，并基于 wp scaffold plugin-tests，该工具为 travis-ci 提供支持。

安装

可以直接在您的 wp-content 文件夹中开发此插件。运行 gulp 以生成压缩和连接的文件并开始监视过程。每当脚本或样式发生变化时，gulp 都会重新编译它们到相应的 css 和 js 文件。

当您想要提供分发版本时，运行 gulp build 并分发生成的 .zip 文件。

推荐工具

国际化工具

WordPress 插件脚手架使用一个变量来存储在脚手架中国际化字符串时使用的文本域。为了利用此方法，有一些工具被推荐用于提供正确、可翻译的文件

• Poedit
• makepot
• i18n

上述任何工具都应为您提供国际化的插件所需的正确工具。

许可证

WordPress 插件模板在 GPL v2 或更高版本下授权。

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

本程序的分发旨在使其有用，但没有任何保证；甚至不保证其可销售性或适用于特定用途。有关详细信息，请参阅 GNU 通用公共许可证。

您应已收到本程序的 GNU 通用公共许可证副本；如果没有，请写信给自由软件基金会，地址：51 Franklin St, 第五层，波士顿，MA 02110-1301 美国。

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

重要说明

许可证

WordPress 插件模板在 GPL v2 或更高版本下授权；然而，如果您选择使用与 v2 不兼容的第三方代码，那么您可能需要切换到使用与 GPL v3 兼容的代码。

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

包含

请注意，如果您包含第三方库，请使用 bower install --save-dev（用于前端库）或 composer require（用于 PHP 库）。

请注意，模板的早期版本不包括 Loader，但此类用于将所有过滤器和动作注册到 WordPress 上。

提供的示例代码展示了如何使用 Loader 类注册您的钩子。更多信息将在网站上的即将发布的文档中提供。

资源

“资源”目录包含三个文件。

1. banner-772x250.png 用来表示插件的头部图片。
2. icon-256x256.png 用来表示插件的图标图片（自 WordPress 4.0 以来为新增）。
3. screenshot-1.png 用来表示与插件“屏幕截图”标题相对应的单张截图。

WordPress 插件存储库目录结构包含三个目录：

1. 资源
2. 分支
3. 主干

模板支持 资源 和 主干 作为 分支 不常使用，并且当它被使用时，通常是在高级情况下。

提交代码到 WordPress 插件存储库时，所有横幅、图标和截图应放在存储库的 资源 目录中，而核心代码应放在 主干 目录中。

致谢

WordPress 插件模板是由 Tom McFarlin 于 2011 年开始的，并自那时起收到了许多优秀的贡献。

当前版本的模板是与 Josh Eaton、Ulrich Pogson 和 Brad Vincent 合作开发的。此分支由 James DiGioia 开发和维护。

首页基于由HTML5Up提供的样式设计，Boilerplate标志由BungaWeb的Rob McCaskill设计，网站的favicon由Mickey Kay创建。