getolympus/olympus-textarea-field

This package is abandoned and no longer maintained. The author suggests using the getolympus/olympus-dionysos-field-textarea package instead.

Textarea field, this component is a part of the Olympus Dionysos fields.

v0.0.18 2023-12-20 22:17 UTC

Requires (Dev)

• phpunit/phpunit: ~5.3

MIT

• Achraf Chouk

• framework
• php
• wordpress
• custom
• field
• textarea
• olympus
• dionysos

README

Dionysos Textarea Field

This component is a part of the Olympus Dionysos fields for WordPress.
Adds a counter JS component on textarea.

composer require getolympus/olympus-dionysos-field-textarea

Table of contents

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

Field initialization

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

return \GetOlympus\Dionysos\Field\Textarea::build('my_textarea_field_id', [
    'title'       => 'How do Penguins drink their cola?',
    'default'     => 'On the rocks.',
    'description' => 'A simple question to know if you will be able to survive to the Penguin domination.',
    'counter'     => true,
    'placeholder' => 'Tell us how?',
    'readonly'    => false,
    'rows'        => 8,

    /**
     * Texts definition
     * @see the `Texts definition` section below
     */
    't_length_label' => 'characters.',
]);

Variables definitions

Variable	Type	Default value	Accepted value	Description
title	String	'Textarea'	empty
default	String	empty	empty	Sets default value if none found
description	String	empty	empty
counter	Boolean	true	true or false	Defines whether or not to display the counter widget
placeholder	String	empty	empty	For default mode only
readonly	Boolean	false	true or false	Defines whether or not to allow modification
rows	Integer	8	> 1

Texts definition

Code	Default value	Definition
t_length_label	characters.	Used to display characters counter as %d characters.

Retrive data

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

// Get textarea from Database
$textarea = get_option('my_textarea_field_id', '');

// Display textarea in HTML tag
echo '<pre>'.htmlspecialchars($textarea).'</pre>';

Release History

Version	Note
0.0.18	Fix jQuery integration on domReady
0.0.17	Change id on twig template
0.0.16	Remove RTE mode from package

Contributing

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

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