包参考

WordPress 提供了一系列用于 WordPress 开发的 JavaScript 包和工具。

有关在 Gutenberg 中创建和管理包的信息，请参阅 packages README。有关构建系统和包配置的详细信息，请参阅 @wordpress/build README。

包指南

包是 Gutenberg 架构的第一层。每个包应具有单一、明确的目的，包含 README，记录前置条件和公共 API，并避免使用工具类/大杂烩模式。除非需要全局变量或模块，否则默认使用捆绑包。

完整指南请参阅 packages README 中的 package guidelines。

通过 WordPress 全局变量使用包

JavaScript 包作为已注册的脚本在 WordPress 中可用，可以使用 wp 全局变量访问。

如果您想使用块编辑器模块中的 PlainText 组件，首先需要在入队脚本时将 wp-block-editor 指定为依赖项：

wp_enqueue_script(
    'my-custom-block',
    plugins_url( $block_path, __FILE__ ),
    array( 'react', 'wp-blocks', 'wp-block-editor', 'wp-i18n' )
);

声明依赖项后，您可以在 JavaScript 代码中使用全局 wp 访问该模块，如下所示：

const { PlainText } = wp.blockEditor;

通过 npm 使用包

如果您希望在代码中捆绑这些包，所有包也可在 npm 上获取。

继续使用相同的 PlainText 示例，您可以通过 npm 安装块编辑器模块：

npm install @wordpress/block-editor --save

安装完成后，您可以使用以下方式在代码中访问该组件：

import { PlainText } from '@wordpress/block-editor';

测试特定主要 WordPress 版本的 JavaScript 代码

有一种方法可以快速安装与给定 WordPress 主要版本一起使用的单个 WordPress 包的版本，方法是使用 npm distribution tags（例如 WordPress 5.8.x）：

npm install @wordpress/block-editor@wp-5.8

还可以通过单个命令更新项目中所有现有的 WordPress 包：

npx @wordpress/scripts packages-update --dist-tag=wp-5.8

支持从 5.7.x 开始的所有主要 WordPress 版本（例如 wp-5.7 或 wp-6.0）。每个单独的 dist-tag 始终指向该主要版本行的最新错误修复版本。