本指南将帮助您设置正确的开发环境,以创建扩展和修改 WordPress 区块编辑器的区块及其他插件。

区块开发环境包括您在计算机上成功为区块编辑器开发所需的工具。三个基本要求是:

若要为 Gutenberg 项目本身做出贡献,请参阅 代码贡献指南 中的额外文档。

代码编辑器

代码编辑器用于编写代码。您可以使用您最习惯的任何编辑器。关键是能够打开、编辑和保存文本文件。

如果您还没有首选的代码编辑器,Visual Studio Code (VS Code) 是核心贡献者中流行的 JavaScript 开发选择。它在三大主要平台(Windows、Linux 和 Mac)上运行良好,是开源的,并由 Microsoft 积极维护。VS Code 还拥有充满活力的社区提供插件和扩展程序,其中包括许多用于 WordPress 开发的工具。

Node.js 开发工具

Node.js (node) 是一个开源运行时环境,允许您在 Web 浏览器之外执行 JavaScript。虽然 Node.js 并非所有 WordPress JavaScript 开发所必需,但在与现代 JavaScript 工具一起工作并为区块编辑器开发时至关重要。

Node.js 及其配套的开发工具允许您:

  • 安装和运行用于区块编辑器开发的 WordPress 包,例如 wp-scripts
  • 使用 wp-env 和 @wp-playground/cli 设置本地 WordPress 环境
  • 使用最新的 ECMAScript 功能并以 ESNext 编写代码
  • 检查、格式化并测试 JavaScript 代码
  • 使用 create-block 包搭建自定义区块

列表未尽。虽然现代 JavaScript 开发可能具有挑战性,但 WordPress 提供了多种工具,如 wp-scripts 和 create-block,这些工具简化了流程,并得益于 Node.js 开发工具。

区块开发的推荐 Node.js 版本是 Active LTS(长期支持)。然而,有时您需要使用不同的版本。强烈推荐使用像 nvm 这样的 Node.js 版本管理工具,它允许您在需要时更改您的 node 版本。您还需要 Node Package Manager (npm) 和 Node Package eXecute (npx) 来与某些 WordPress 包一起工作。两者均随 Node.js 自动安装。

为了能够使用 Node.js 工具和 WordPress 提供的包 进行区块开发,您需要在机器上设置正确的 Node.js 运行时环境。有关如何执行此操作的更多信息,请参阅下面的链接。

本地 WordPress 环境

本地 WordPress 环境(站点)提供了一个受控、高效且安全的开发空间,允许您在将代码部署到生产站点之前构建和测试您的代码。WordPress 的相同 要求 也适用于本地站点。

在更广泛的 WordPress 社区中,有许多工具可用于在计算机上设置本地 WordPress 环境。区块编辑器手册涵盖 wp-env,它是开源的,并由 WordPress 项目本身维护。它也是 Gutenberg 开发的推荐工具。

请参阅 使用 wp-env 入门 指南以获取设置说明。

在整个手册中,您还可能看到对 @wp-playground/cli 的引用。这是一个由 WordPress Playground 驱动的轻量级工具,可简化简单本地 WordPress 环境的设置。此工具非常适合快速测试 WordPress 发布版、区块、插件和主题。

此列表并非详尽无遗,但如果您不想使用 wp-env,这里有几个其他选项可供选择: