README

Dionysos 文本字段

此组件是 WordPress 的 Olympus Dionysos 字段 的一部分。
它使用默认的 WordPress 文本字段来显示密码、范围、文本、日期时间、电话等字段。

composer require getolympus/olympus-dionysos-field-text

字段初始化

使用以下行在您的 WordPress 管理页面或自定义帖子类型元字段中添加 文本字段

return \GetOlympus\Dionysos\Field\Text::build('my_text_field_id', [
    'title'       => 'What do you like?',
    'default'     => 'Penguins, I am sure they\'re gonna dominate the World!',
    'description' => 'Put in here everything you want.',
    'placeholder' => 'McDonald\'s as well',
    'type'        => 'text',

    /**
     * Settings definition
     * @see the `Settings definition` section below
     */
    'settings' => [],
]);

变量定义

变量	类型	未设置时的默认值	接受的值
`title`	字符串	`'Text'`	empty
`default`	字符串	empty	empty
`description`	字符串	empty	empty
`placeholder`	字符串	empty	empty
`type`	字符串	`'text'`	见接受的类型
`settings`	数组	见字段初始化	见设置定义

接受的类型

date 见日期类型
datetime-local 见本地日期时间类型
email 见电子邮件类型
hidden 见隐藏类型
month 见月份类型
number 见数字类型
password 见密码类型
range 见范围类型
search 见搜索类型
tel 见电话类型
text 见文本类型
time 见时间类型
url 见 URL 类型
周 查看周类型

设置定义

settings 变量是一个数组，其选项取决于 type 值。
在所有情况下，以下是一些默认设置及其说明

变量	类型	未设置时的默认值	接受的值
`attrs`	字符串	empty	empty
`after`	字符串	empty	empty
`before`	字符串	empty	empty
`class`	字符串	empty	empty
`readonly`	布尔型	`false`	`true` 或 `false`

特殊情况： attrs 允许您添加所需的全部附加属性，例如 data-*。 请注意 这一点！
after 将内容插入字段之后。在 number 和 range 情况下，after 内容将预置 max 值。
before 将内容插入字段之前。在 number 和 range 情况下，before 内容将附加 min 值。
class 将 CSS 类添加到已存在的 regular-text 字段类中（在 hidden 情况下不使用）。
readonly 当其值设置为 true 时，将避免使用字段。

日期类型

有关 Mozilla 日期页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`max`	日期	empty	接受的最晚日期，格式为 `yyyy-MM-dd`。
`min`	日期	empty	接受的最早日期，格式为 `yyyy-MM-dd`。
`step`	整数	empty	整数，表示为 `day`。

日期时间本地类型

有关 Mozilla 日期时间本地页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`max`	日期	empty	接受的最晚日期，格式为 `yyyy-MM-ddThh:mm`。
`min`	日期	empty	接受的最早日期，格式为 `yyyy-MM-ddThh:mm`。
`step`	整数	empty	整数，表示为 `second`。

电子邮件类型

有关 Mozilla 电子邮件页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`maxlength`	整数	empty	empty
`minlength`	整数	empty	empty
`multiple`	布尔型	`false`	`true` 或 `false`
`pattern`	字符串	empty	JavaScript 正则表达式
`size`	整数	empty	empty
`spellcheck`	布尔型	`false`	`true` 或 `false`

隐藏类型

有关 Mozilla 隐藏页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`display`	布尔型	`false`	`true` 或 `false`

这个特殊的 display 变量定义了隐藏字段是否需要显示字段值。

设置为 false，将显示值存储在数据库中的句子。
设置为 true，将显示值存储在数据库中的句子以及当前值。

月份类型

有关 Mozilla 月份页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`max`	日期	empty	接受的最晚日期，格式为 `yyyy-MM`。
`min`	日期	empty	接受的最早日期，格式为 `yyyy-MM`。
`step`	整数	empty	整数，表示为 `month`。

数字类型

有关 Mozilla 数字页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`max`	浮点数	empty	empty
`min`	浮点数	empty	empty
`step`	浮点数	empty	empty

密码类型

有关 Mozilla 密码页面的完整文档。

变量	类型	未设置时的默认值	接受的值
`maxlength`	整数	empty	empty
`minlength`	整数	empty	empty
`pattern`	字符串	empty	JavaScript 正则表达式
`size`	整数	empty	empty

范围类型

在Mozilla Range 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`数据列表`	数组	empty	用户可以选择以自动填充控件值的建议列表
`max`	浮点数	empty	empty
`min`	浮点数	empty	empty
`step`	浮点数	empty	empty

此 range 类型将显示带有字段值的输入 number HTML 标签。

搜索类型

在Mozilla Search 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`maxlength`	整数	empty	empty
`minlength`	整数	empty	empty
`pattern`	字符串	empty	JavaScript 正则表达式
`size`	整数	empty	empty
`spellcheck`	布尔型	`false`	`true` 或 `false`

电话类型

在Mozilla Tel 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`maxlength`	整数	empty	empty
`minlength`	整数	empty	empty
`pattern`	字符串	empty	JavaScript 正则表达式
`size`	整数	empty	empty

文本类型

在Mozilla Text 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`maxlength`	整数	empty	empty
`minlength`	整数	empty	empty
`pattern`	字符串	empty	JavaScript 正则表达式
`size`	整数	empty	empty
`spellcheck`	布尔型	`false`	`true` 或 `false`

时间类型

在Mozilla Time 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`max`	日期	empty	接受的最晚时间，格式为 `hh:mm` 或 `hh:mm:ss`
`min`	日期	empty	接受的最早时间，格式为 `hh:mm` 或 `hh:mm:ss`
`step`	整数	empty	整数，表示为 `second`。

当提供 step 变量时，浏览器将在分钟部分旁边添加秒输入区域。
max 和 min 变量的格式将自动强制为 hh:mm:ss。

URL 类型

在Mozilla URL 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`数据列表`	数组	empty	用户可以选择以自动填充控件值的建议列表
`maxlength`	整数	empty	empty
`minlength`	整数	empty	empty
`pattern`	字符串	empty	JavaScript 正则表达式
`size`	整数	empty	empty
`spellcheck`	布尔型	`false`	`true` 或 `false`

周类型

在Mozilla Week 页面上查看完整文档

变量	类型	未设置时的默认值	接受的值
`max`	日期	empty	接受的最晚时间，格式为 `yyyy-Www`
`min`	日期	empty	接受的最早时间，格式为 `yyyy-Www`
`step`	整数	empty	整数，表示为 `1week`

检索数据

使用简单的 get_option('my_text_field_id', '') 从数据库中检索您的值（参见 WordPress 参考）

// Get text from Database
$text = get_option('my_text_field_id', '');

// Display text
echo $text;

发布历史

版本	注意
0.0.23	修复 domReady 上的 jQuery 集成
0.0.22	更改主 DIV id 以避免与标签的 HTML 冲突
0.0.21	为 `range` 类型启用 `datalist` 建议

贡献

分支（https://github.com/GetOlympus/olympus-dionysos-field-text/fork）
创建您的功能分支（git checkout -b feature/fooBar）
提交您的更改（git commit -am 'Add some fooBar'）
推送到分支（git push origin feature/fooBar）
创建新的拉取请求

由 Achraf Chouk 使用♥构建 ~ 自从很久以前开始。

getolympus / olympus-text-field

维护者

详细信息