fleflis/carbon-field-slider

Carbon Fields 扩展,增加了滑动字段类型。

1.1.0 2021-03-22 18:47 UTC

This package is auto-updated.

Last update: 2024-09-23 02:41:16 UTC


README

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

简介

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

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

步骤 1:下载模板

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

您可以从这里下载模板: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 以在开发期间持续构建包。请注意,您应该在 wp-config.php 文件中添加 define( 'SCRIPT_DEBUG', true );,以便加载由开发构建过程生成的文件。

步骤 4:自定义

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

PHP

to_json()

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

field_type_activated

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

admin_enqueue_scripts()

用于添加 CSS/JavaScript 文件。

admin_init()

当字段初始化时,对每个字段实例进行调用。(后端)

init()

当字段初始化时,对每个字段实例进行调用。(后端,前端)