@wordpress/创建块

创建块是一个官方支持的搭建注册块的WordPress插件的工具它生成PHP、JS、CSS代码以及启动项目所需的所有内容。它还集成了无配置的现代构建设置。

它的灵感主要来自创建-反应-应用程序.主要荣誉@盖伦整个Facebook团队和React社区。

块是现代WordPress网站的基本元素。引入于WordPress 5.0(文字出版社5.0),他们允许页面和后期构建类功能到每个最新的WordPress网站。

了解有关Gutenberg手册中的块API.

快速入门

$npx@wordpress/创建区块@最新待办事项列表$cd待办事项列表$npm开始

这个段塞提供(待办事项列表在示例中)定义了scaffolded插件的文件夹名和内部块名。生成的WordPress插件必须手动安装.

(需要节点版本20.10.0或以上,以及净现值法版本10.2.3或以上)

在Learn.wordpress.org上观看create-block的视频介绍

用法

这个创建块该命令使用PHP、JS和CSS代码生成一个项目,用于使用WordPress插件注册块。

$npx@wordpress/create-block@最新[options][slug](选项)

演示

块的名称是标识块的唯一字符串。块名称的结构为命名空间/段塞,其中namespace是插件或主题的名称。

在大多数情况下,我们建议将块与WordPress插件配对,而不是与主题配对,因为只有使用插件才能确保所有块在主题更改时仍然有效。

交互式模式

当没有段塞则脚本将以交互模式运行,并开始提示所需的输入(段塞,title,namespace…)来构建项目。

段塞

使用段塞是可选的。

当提供时,它会触发快速模式,在哪里段塞使用:
–作为块段塞(识别所需)
–作为脚手架文件的输出位置(文件夹名称)
–作为WordPress插件的名称。

除非使用下面列出的某些选项覆盖,否则其余配置将设置为所有默认值。

选项

-V、 --version输出版本号-t、 ——模板<名称>项目模板类型名称;允许值:“static”(默认)、“es5”、外部npm包的名称或本地目录的路径--仅限no-plugin脚手架块文件--块名称的namespace<value>内部命名空间--title<value>显示块和WordPress插件的标题--简短描述<value>块和WordPress插件的简短描述--块的类别名称--wp-scripts支持与`@wordpress/scripts`包集成--no-wp-scripts禁用与`@wordpress/scripts`包的集成--wp-env支持与`@wordpress/env`包的集成-h、 --帮助输出使用信息--变量选择模板定义的块变量

--模板

此参数指定外部npm包作为模板。

$npx@wordpress/create-block@最新--模板my-template-package

此参数还允许选择本地目录作为模板。

$npx@wordpress/create-block@最新--模板/路径/目标/模板目录

--变体

有了这个论点,创建块将生成动态块基于内置模板。

$npx@wordpress/create-block@最新--变量动态

--帮助

有了这个论点创建块包输出使用信息。

$npx@wordpress/create-block@最新--帮助

--无凝集素

有了这个论点创建块包在中运行无插件模式它只将块文件转移到当前目录中。

$npx@wordpress/create-block@最新--无插件

--wp-env公司

有了这个论点创建块包将向生成的插件添加要运行的配置和脚本wp-env公司包裹在插件中。这将允许您轻松设置本地WordPress环境(通过Docker),以构建和测试生成的插件。

$npx@wordpress/create-block@最新--wp-env

脚手架项目中的可用命令

执行此命令时创建的插件文件夹是一个节点包,具有无需配置的现代构建设置。

该文件夹中有一组脚本(由脚本包)使您的工作更轻松。单击此处以获取这些命令的完整描述。

注意:您不需要安装或配置以下工具网络包,巴别塔ESLint公司你自己。它们是预配置和隐藏的,以便您可以专注于编码。

例如,运行开始从生成的文件夹内执行脚本(npm启动)将自动启动构建以进行开发。

外部项目模板

单击此处有关外部项目模板的信息

参与此包

这是古腾堡项目的一部分。该项目组织为单回购。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值法并由使用WordPress(文字出版社)以及其他软件项目。

要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容贡献者指南.