块的文件结构

在为WordPress开发自定义块时,最好在插件中注册它们,而不是在主题中注册。此策略确保即使用户切换主题,也可以访问块。虽然在某些情况下,将块直接嵌入主题可能是合适的,但本指南重点关注插件中的块。具体来说,它详细说明了创建块工具。

坚持创建块该工具的结构不是强制性的,但它可以作为可靠的参考。它生成的文件包含块定义和注册所需的所有内容。遵循这种结构可以帮助保持一致性,并确保您的块组织良好且易于维护。

方块图图像的打开文件结构

<插件文件>.php

在WordPress插件中创建块时,通常会在服务器上的插件主PHP文件中注册块。这是使用寄存器块类型()功能。

有关创建WordPress插件的更多信息,请参阅插件基础知识标题要求用于主PHP文件。

package.json包

这个package.json包文件用于配置Node.js项目,这在技术上是块插件。在这个文件中,您可以定义净现值法用于本地开发的块和脚本的依赖关系。

src文件夹

在标准项目中型钢混凝土(source)文件夹包含未编译的原始代码,包括JavaScript、CSS和开发块所需的其他资产。在这里,您可以编写和编辑块的源代码,利用现代JavaScript特性和用于React组件的JSX。

这个构建过程由提供wp-脚本然后将从该文件夹中获取文件,并在项目的建造文件夹。

块.json

这个块.json文件包含块的元数据,跨客户端和服务器端环境简化其定义和注册。

该文件包括块名称、描述、,属性,支架以及负责块的功能、外观和样式的基本文件的位置。

应用生成过程时块.json文件和其他生成的文件被移动到指定的文件夹中,通常建造文件夹。因此,在中指定的文件路径块.json指向这些经过处理的捆绑版本的文件。

可以在块.json是:

  • 编辑器脚本:通常设置为捆绑路径索引.js从中生成的文件源代码/索引.js.
  • 风格:通常设置为捆绑路径样式index.css从中生成的文件src/样式。(css|scss|sass).
  • 编辑器样式:通常设置为捆绑路径索引.css它是从src/编辑器。(css|scss|sass).
  • 提供:通常设置为捆绑的路径渲染.php复制自src/render.php.
  • 查看脚本:通常设置为捆绑路径视图.js它是从源代码/视图.js.

在excalidraw中打开生成输出图

索引.js

这个索引.js文件(或编辑器脚本的属性块.json)是JavaScript的入口点文件,只应在块编辑器中加载。它负责呼叫寄存器块类型函数在客户端上注册块,并通常导入编辑.js保存.js文件以获取块注册所需的函数。

编辑.js

这个编辑.js文件包含负责渲染块的编辑用户界面的React组件,允许用户在块编辑器中交互和自定义块的内容和设置。此组件传递给编辑的属性寄存器块类型中的函数索引.js文件。

保存.js

这个保存.js导出返回保存到WordPress数据库的静态HTML标记的函数。此函数传递给节约的属性寄存器块类型中的函数索引.js文件。

样式。(css|scss|sass)

A类风格带扩展名的文件.css文件,.scss文件,或.sas文件包含将在块编辑器和前端加载的块的样式。在生成过程中,此文件被转换为样式index.css,通常使用风格中的属性块.json

内部使用的webpack配置wp-脚本包括一个css装载机用链子锁住后ss-loadersass-loader装载机允许它处理CSS、SASS或SCSS文件。检查默认webpack配置了解更多信息

编辑。(css|scss|sass)

编辑带有扩展名的文件.css文件,.scss文件,或.sas文件包含在块编辑器中应用于块的其他样式。您通常会将此文件用于块的用户界面特定的样式。此文件已转换为索引.css在构建过程中,通常使用编辑器样式中的属性块.json.

渲染.php

这个渲染.php文件(或提供的属性块.json)定义当前端发出请求时返回块标记的服务器端进程。如果已定义,则此文件将优先于其他在前端渲染块标记的方式。

视图.js

这个视图.js文件(或查看脚本的属性块.json)显示块时,将在前端加载。

生成文件夹

这个建造文件夹包含来自型钢混凝土文件夹。这些文件是从构建过程,由触发建造开始的命令wp-脚本.

此转换过程包括缩小、从现代JavaScript转换为与更广泛浏览器兼容的版本,以及捆绑资产以实现高效加载。WordPress最终排队并使用建造文件夹的内容以在块编辑器和前端渲染块。

你可以使用webpack-src-dir输出通路的选项wp-脚本生成命令到自定义入口和输出点.

其他资源