title: "包参考文档" post_status: publish comment_status: open taxonomy: category: - gutenberg-docs post_tag: - Reference Guides - Repos - Data

包参考文档

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

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

包开发指南

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

完整指南请参阅包 README 中的 包开发指南。

通过 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 分发标签（以 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）。每个分发标签始终指向该主版本线的最新错误修复版本。