README

Dionysos Text Field

This component is a part of the Olympus Dionysos fields for WordPress.
It uses the default WordPress text field to display password, range, text, datetime, tel, and more fields.

composer require getolympus/olympus-dionysos-field-text

Field initialization • Variables definition • Settings definition • Retrive data • Release History • Contributing

Field initialization

Use the following lines to add a text field in your WordPress admin pages or custom post type meta fields:

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' => [],
]);

Variables definition

Accepted type

date see Date type
datetime-local see Datetime-local type
email see Email type
hidden see Hidden type
month see Month type
number see Number type
password see Password type
range see Range type
search see Search type
tel see Tel type
text see Text type
time see Time type
url see URL type
week see Week type

Settings definition

The settings variable is an array of options depending on type value.
In all cases, here are the default settings with their explanations:

Special case: attrs will let you add all additional attributes you need, such as data-*. Pay attention to this!
after will insert contents after the field. In number and range cases, the after content will prepend the max value
before will insert contents before the field. In number and range cases, the before content will append the min value
class will add CSS classes to the already-in regular-text field class (not used in hidden case)
readonly will avoid the field to be used when its value is set to true

Date type

Full documentation on Mozilla Date page

Datetime-local type

Full documentation on Mozilla Datetime-local page

Email type

Full documentation on Mozilla Email page

Hidden type

Full documentation on Mozilla Hidden page

This special display variable defines if the hidden field have to show field value or not:

set to false, a sentence will show where the value is stored in Database
set to true, a sentence will show where the value is stored in Database and what is the current value

Month type

Full documentation on Mozilla Month page

Number type

Full documentation on Mozilla Number page

Password type

Full documentation on Mozilla Password page

Range type

Full documentation on Mozilla Range page

This range type will display an input number HTML tag with the field value.

Search type

Full documentation on Mozilla Search page

Tel type

Full documentation on Mozilla Tel page

Text type

Full documentation on Mozilla Text page

Time type

Full documentation on Mozilla Time page

When the step variable is provided, browser will add the seconds input area adjacent to the minutes section.
The max and min variables format will automatically be forced to hh:mm:ss.

URL type

Full documentation on Mozilla URL page

Week type

Full documentation on Mozilla Week page

Retrive data

Retrieve your value from Database with a simple get_option('my_text_field_id', '') (see WordPress reference):

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

// Display text
echo $text;

Release History

Contributing

Fork it (https://github.com/GetOlympus/olympus-dionysos-field-text/fork)
Create your feature branch (git checkout -b feature/fooBar)
Commit your changes (git commit -am 'Add some fooBar')
Push to the branch (git push origin feature/fooBar)
Create a new Pull Request

Built with ♥ by Achraf Chouk ~ (c) since a long time.

getolympus / olympus-dionysos-field-text

Maintainers

Details