README

内容

• 简介
• 覆盖默认twig模板
• 任务自动化
• Composer
• 代码标准
• 贡献

简介

此WordPress插件提供与Shortcake UI插件一起使用的必要块。

覆盖块默认twig模板

您可以通过在子主题的 /templates/plugins/planet4-plugin-blocks/includes/ 子目录中包含一个同名文件来覆盖默认的块twig模板。

您如何开发一个新块呢？

1. 在 classes/controller/blocks 目录中创建一个新的控制器类，该类扩展了Controller。类名应遵循命名约定，例如 Blockname_Controller，其文件名应为 class-blockname-controller.php。

2. 实现其父类的两个抽象方法。在 prepare_fields() 方法中，您需要定义块的字段，在 prepare_data() 方法中，您需要准备用于渲染的数据。

3. 在 includes/blocks 目录中创建一个用于渲染您块的模板文件。如果文件名为 blockname.twig，则需要将 BLOCK_NAME 常量设置为 'blockname'。它也可以与HTML模板一起使用。只需将 'php' 作为 block() 方法的第三个参数添加即可。

4. 将您的新类名添加到插件主文件中 Loader 函数参数的数组中。

5. 最后，在提交之前，执行 composer update --no-dev 和 composer dump-autoload --optimize 以将您的新类添加到 composer 的自动加载中。

任务自动化

我们使用gulp作为本地开发的自动化工具。

可用任务

• gulp lint_css '检查css/sass的lint错误'
• gulp lint_js '检查js的lint错误'
• gulp sass '合并/编译sass文件为单个最小化样式表'
• gulp sass_admin '合并/编译管理sass文件为单个最小化样式表'
• gulp uglify '合并/混淆js文件为单个最小化js文件'
• gulp uglify_admin '合并/混淆管理js文件为单个最小化js文件'
• gulp watch '监视js或scss的变化并运行最小化任务'
• gulp git_hooks '将仓库的git钩子复制到本地git仓库'

Composer

我们使用composer作为此插件的依赖管理器。要安装依赖项，请运行

$ composer install

代码标准

我们遵循 WordPress编码标准

我们使用自定义的 php codesniffer 规则集，该规则集在 WordPress-Core、WordPress-Docs 和 WordPress-Extra 规则集的基础上增加了某些规则。

WordPress 编码标准规则集

WordPress 编码标准 Wiki

运行 php codesniffer

$ vendor/bin/phpcs 或 $ composer sniffs

运行 php 代码美化器和修复器

$ vendor/bin/phpcbf 或 $ composer fixes

贡献

请阅读 Planet4 的 贡献指南。