README

** 开发中。尚未准备好用于生产。

WordPress 插件扩展和自定义的中心仓库

特性

• Pimple 容器依赖注入
• 内置初始化任务
  • 系统环境兼容性检查
  • 插件常量，可以添加更多
  • 队列管理器，用于将样式和脚本添加到 WordPress
  • 本地化 - 包含一个 .pot 文件作为国际化起始点
  • 类处理所有激活/停用/安装任务
• 模块
  • 配置 - 将模块的运行时配置从模块中抽象到 config 文件夹
  • 事件管理 - 与 WordPress 插件 API 交互
  • 文件和模板加载器
• Composer 自动加载器
• 遵循 PSR-4 编码标准
• 包括 Laravel Mix，用于简单的 webpack 实现
• 自定义文章类型功能 - 通过配置文件配置

要求

在继续之前，请确保已安装所有依赖项

• WordPress >= 4.7
• PHP >= 7.0
• Composer
• Node.js >= 6.9.x

安装

1. 从命令行导航到您的 WordPress mu-plugins 目录。
2. 运行此命令： composer create-project sb2-media/wordpress-starter-plugin。
3. 将 wordpress-starter-plugin 目录重命名为 your-plugin-name。
4. 切换到插件目录： cd your-plugin-name。
5. 更新 package.json 文件以包含您的信息。
6. 在 plugin.php 中更新主插件头部以包含您的插件信息。
7. 运行 npm install。
8. 运行 npm run dev。
9. 全局搜索并替换 SB2Media\Hub 命名空间为 YourCompanyName\YourPluginName。
10. 使用相关的信息更新 composer.json，包括在 autoload 部分中定义的命名空间。它们必须与上一步中使用的命名空间匹配。
11. 运行 composer dump-autoload -o。
12. 在 WordPress 控制台中，转到 插件 页面，找到名为“Your Plugin Name”的菜单项。
13. 点击 激活。

请注意，这将激活起始插件的源代码，但由于它没有任何实际功能，所以不会添加菜单项、元框或自定义文章类型。

使用方法

队列资源

队列资源的默认行为是通过在 config 文件夹中找到的两个配置文件来实现的。前端和后端资源可以在 enqueue.php 和 admin-enqueue.php 中分别定义。添加多个文件就像在配置数组中添加另一个条目一样简单。这在每个文件中都有很好的文档说明。

或者（或与之一起），资源可以通过 EnqueueManager 类的 enqueueStyles 和 enqueueScripts 方法来队列。这些最好在 Plugin 类的 enqueueAssets 和 enqueueAdminAssets 方法中调用。

每个要队列的资源都应该放在适当的 assets/sass（默认为 css）、assets/css 和/或 assets/js 子文件夹中。这些文件也必须在插件的根目录中的 webpack.mix.js 中定义，并通过在命令行上执行 npm run dev 或 npm run production 编译到适当的 dist/ 子文件夹。

推荐工具

国际化工具

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

• Poedit
• makepot
• i18n

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

许可证

WordPress 启动插件根据 GPL v2 或更高版本授权。

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

本程序的发布是希望它会是有用的，但没有任何保证；甚至没有关于其商业性或适用于特定用途的暗示性保证。有关更多信息，请参阅GNU通用公共许可证。

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

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

资产

assets/images 目录包含三个文件。

1. banner-772x250.png 用于表示插件的大图。
2. icon-256x256.png 用于表示插件的图标（自WordPress 4.0以来是新的）。
3. screenshot-1.png 用于表示插件的单个截图，对应于您插件 README.txt 中的“截图”标题。

致谢

这个启动插件最初基于2011年由Tom McFarlin启动的《WordPress 插件样板》。当前版本的样板是与Josh Eaton、Ulrich Pogson和Brad Vincent共同开发的。这个直接分叉的版本是由Luís Rodrigues开发的。

本插件还使用了从Carl Alexander和Tonya Mork的Fulcrum插件中改编的代码和概念。