用法

字段是每个容器的构建块。

使用方法创建新字段,其中:makeField::make( $type, $name, $label = null )

$type

字段的类型。此参数应该是字段的有效类名。例如将创建类 textField_Text 的字段

$name

字段的名称。存储在数据库中时用作键并用于检索其值。请注意,所有字段的名称在存储时都会自动加上下划线前缀(例如变为 )bgcolor _bgcolor

$label (optional)

该字段的标签仅显示在后端,容器可见。省略该参数时,自动派生自 。如果省略该参数,并且以 开头,则该部分将不会显示在生成的标签中。$name $name crb_Crb

工厂极大地简化了字段创建过程,因为它返回字段对象本身,您无需将其分配给变量。字段 API 支持方法链接(如下例所示)。

// Create image field with name "customer_photo" and label "Photo"
Field::make( 'image', 'crb_customer_photo', 'Photo' )

// Here the title is automatically set to "Custom Sidebar"
Field::make( 'sidebar', 'crb_custom_sidebar' )

// Method chaining
Field::make( 'select', 'crb_color' )
    ->add_options( array('red', 'blue', 'green') )
    ->set_help_text( 'Pick a color' )

所有字段类型都源自一个名为并继承以下基本特征的类:Field

默认值

您可以为每个容器中的每个字段分配一个默认值。 当数据库中的特定字段当前没有值时,使用默认值。 例如,当您添加新帖子或将新主题选项字段添加到现有容器时就是这种情况。

要分配默认值,请使用:

Field::make(...)->set_default_value( $default_value )

必填字段

您可以根据需要标记任何字段,在这种情况下,用户需要在提交之前填写它。 要根据需要设置字段,请使用:

Field::make(...)->set_required( true )

帮助文本

帮助文本用作对将使用该字段的用户的提示。 它通常呈现在该字段下,并包含有关其应包含内容的更多信息——要求、示例、链接等。允许使用 HTML 标记。

您可以使用以下方式添加帮助文本:

Field::make(...)->set_help_text( $text )

宽度

您可以将宽度设置为彼此相邻的字段,它们将在一行上对齐。 要设置字段宽度 %,请使用:

Field::make(...)->set_width( 50 )
注意:由于 WordPress 术语编辑屏幕使用的表格布局,此功能在术语元容器中没有任何作用。

Classes

可以使用方法添加自定义字段类,例如:set_classes()

Field::make(...)->set_classes( 'my-custom-class' )

属性

您可以使用基于

<input type="text" />

<textarea>

的字段方法覆盖某些字段属性:set_attribute()

Field::make( 'text', 'crb_phone', 'Phone' )
    ->set_attribute( 'placeholder', '(***) ***-****' );

有关允许的属性的完整列表,请访问 Text 或 Textarea 字段文档页面。

REST API

可以使用它们的方法在 WordPress 的 REST API 中公开字段:set_visible_in_rest_api()

Field::make(...)->set_visible_in_rest_api( $visible = true )