sirvelia / carbon-field-free-select

Carbon Fields 扩展,增加了免费选择字段类型。

v0.1.2 2024-06-26 15:13 UTC

This package is auto-updated.

Last update: 2024-09-26 15:51:34 UTC


README

如何创建新的 Carbon Field 的分步指南。

简介

Carbon Fields 库包含许多内置字段,但您可能需要根据特定项目需求定义新的字段类型。

以下教程将解释如何创建自定义的 Carbon Field。

第1步:下载模板

为了使过程尽可能简单,我们已准备了一个包含 PHP Carbon Field 类框架和 webpack 构建过程的 Carbon Field 模板。

您可以从这里下载模板: https://github.com/htmlburger/carbon-field-template

模板结构

  • /src - 字段文件文件夹
  • /languages - .po、.mo 和 .pot 文件文件夹
  • /core - 所有 .php 文件文件夹
  • /field.php - 启动 php 代码

第2步:命名你的字段

在所有文件中将 YOURFIELDNAMEyourfieldname(区分大小写)占位符替换。同时重命名包含占位符的文件。

注意! 如果您的字段名包含多个单词,例如图片库,您的类名应如下所示

  • PHP 类: Image_Gallery_Field
  • 字段组件注册: image_gallery(参考 registerFieldType@/src/index.js

第3步:构建资源

  1. 执行 composer dump-autoload 创建所需的 autoload.php,该文件需要包含在您的主题中。
  2. 在根目录中执行 yarn install 安装所有构建过程需求。
  3. 执行 yarn build 构建最终的压缩包
可选

执行 yarn start 在开发过程中持续构建包。注意,您应该将 define( 'SCRIPT_DEBUG', true ); 添加到您的 wp-config.php 文件中,以便加载由开发构建过程生成的文件。

第4步:自定义

以下是您可以自定义的一些方法概述

PHP

to_json()

您可以使用此方法修改传递给代表字段的 React 组件的字段属性。

field_type_activated

用于调用一次每个字段类型(例如设置本地化文件)的初始化过程。

admin_enqueue_scripts()

用于添加 CSS/JavaScript 文件。

admin_init()

当字段初始化时为每个字段实例调用。(后端)

init()

当字段初始化时为每个字段实例调用。(后端、前端)