开源项目教程：Gutenberg 对象插件

开源项目教程：Gutenberg 对象插件

gutenberg-object-pluginSaves Gutenberg data as an object / array and allows you to access it via REST API 项目地址:https://gitcode.com/gh_mirrors/gu/gutenberg-object-plugin

项目介绍

本项目名为Gutenberg 对象插件，主要目标是将WordPress的新编辑器——Gutenberg产生的数据保存为数据库中的干净数组格式，并使其可以通过REST API访问。由Roy Sivan开发并维护，此插件旨在增强内容管理和API交互能力，特别适合那些希望以更结构化的方式处理Gutenberg编辑器生成的数据的开发者和网站管理员。此外，它还添加了对ACF（Advanced Custom Fields）的支持，提供可预测且实用的JSON输出，类似于acf-to-rest-api插件，但专为Block编辑而设计。

项目快速启动

安装（适用于Rest-Kit）

1. 通过Composer安装: 在你的WordPress项目的根目录运行以下命令来安装插件。

   composer require wp-kit/gutenberg-object-plugin
   

2. 配置Rest-Kit:

   • 在resources/config/constants.php中添加以下行来指定受支持的CPT（自定义帖子类型）。

     define('GUTENBERG_OBJECT_PLUGIN_CPTS', 'page');
     

   • 确保在resources/config/providers.php中包含了插件的provider。

     GutesObjectPlugin\Provider::class,
     

安装（仅WordPress）

• 手动安装: 下载项目ZIP文件，解压后上传到WordPress的插件目录。
• 接着，需要手动进行上述配置步骤中的CPT定义部分，通过FTP或WordPress后台编辑器实现。

应用案例和最佳实践

优化内容API调用

• 使用该插件，你可以直接从客户端获取结构化的Gutenberg块数据，从而简化前端渲染逻辑，提升应用响应速度。

动态页面构建

• 结合REST API，可以在无需额外服务器端渲染的情况下，动态地基于Gutenberg创建的内容构建Web页面，特别是在单页应用(SPA)中。

数据一致性管理

• 保证通过REST API访问的数据与编辑器内一致，简化前后端分离的开发流程。

典型生态项目结合

虽然该项目自身就是一个生态增强工具，但与其他如ACF、WP REST API及现代前端框架（如React或Vue.js）的结合尤其值得强调。通过ACF，开发者可以进一步定制Gutenberg编辑体验，生成更加复杂的块结构，然后利用Gutenberg对象插件无缝推送到前端，用现代前端技术实现动态界面，提高开发效率和用户体验。

请注意，对于第三方Block的支持，可通过向项目提交Issue请求特定插件的支持，作者或社区可能会增加兼容性，确保广泛的Block生态系统能够被有效地集成利用。

---

以上就是关于Gutenberg对象插件的基本介绍、快速启动指南、应用案例以及与典型生态项目的结合方式。利用此插件，开发者可以更高效地管理和利用Gutenberg编辑器的数据，推动WordPress项目向现代化和高度可扩展的方向发展。

gutenberg-object-pluginSaves Gutenberg data as an object / array and allows you to access it via REST API 项目地址:https://gitcode.com/gh_mirrors/gu/gutenberg-object-plugin