README

rest-kit 是一个用于将 Wordpress 作为无头 CMS 使用的微型 RAD 解决方案。

安装

下载 Composer 并使用以下命令安装：

cd wp-content/themes
composer create-project wp-kit/rest-kit rest-kit --prefer-dist

使用 Bedrock 吗？

首先安装 Bedrock，然后：

composer require wp-kit/rest-kit
cp -r vendor/wp-kit/rest-kit web/app/themes
(rm ./package.json || true) && mv web/app/themes/rest-kit/package.json ./package.json
(rm ./webpack.config.js || true) && mv web/app/themes/rest-kit/webpack.config.js ./webpack.config.js

// inside webpack.config.js change the following
const themeFolder = './web/app/themes/rest-kit';

npm i
npm run build

何时应使用 wp-kit/rest-kit？

如果您正在寻找一个框架来构建和管理自定义 Gutenberg 块（React 风格或 ACF 块），并想管理块在编辑器中的外观和样式，并通过 Wordpress REST API 消费 Gutenberg 块数据，同时希望轻松注册文章类型和分类法，并在控制器和文章类型/分类法类中上下文中组织代码，那么这是一个完美的框架。功能包括：

Webpack 配置，可轻松创建、编辑和为编辑器中的 React 风格 Gutenberg 块设置样式
Gutenberg 块被 JSON 化并作为文章（CPT）和页面中的 WP REST API 响应发送
ACF 块通过配置轻松注册，并通过视图文件进行管理
ServiceProvider 配置
文章类型注册
分类法注册
根据条件调用控制器

只想在 WP REST 响应中获取块？

rest-kit 的一个关键特性是它输出 JSON 块，包括 ACF 块，在 API 响应中的 gblocks 属性下。当您想添加自定义 React 风格的块或注册和管理 ACF 块时，该框架很棒，但如果您不需要这些功能或认为 rest-kit 对您来说太过于复杂，我们已将 JSON 块功能抽象到它自己的插件中。

WP ACF Rest API 块

Gists

菜单端点

我们最近从模板代码中默认删除了菜单端点，以支持使用 WP Rest API V2 Menus。您可以轻松将其添加回来。

在 wp-kit/rest-kit 中添加菜单端点，如果您不想使用 plugins/wp-rest-api-v2-menus

调整 Gutenberg JSON

我们最近删除了转换代码，因此响应中接收到的块模式与 parse_blocks() 提供的模式完全相同。您可以随意更改和转换它。

调整 REST 响应中的 Gutenberg 块输出

参与进来

任何帮助都受欢迎。该项目是开源的，我们鼓励您参与其中。您可以通过以下多种方式为项目做出贡献：

报告错误问题
建议功能
发送包含代码修复或功能的拉取请求
在 GitHub 上关注项目
在您的社区中分享项目

需求

Wordpress 5+

PHP 7.4+

Composer

Node

NPM

安全漏洞

如果您在 wp-kit/rest-kit 中发现安全漏洞，请发送电子邮件至 tech@creativelittledots.co.uk 或在存储库中提出问题。所有安全漏洞都将得到及时处理。

许可

wp-kit/rest-kit 是在 MIT 许可下许可的开源软件。

wp-kit / rest-kit

维护者

详细信息