README

Dionysos Rte Field

This component is a part of the Olympus Dionysos fields for WordPress.
It uses the default WordPress RTE field.

composer require getolympus/olympus-dionysos-field-rte

Field initialization • Variables definition • Retrive data • Release history • Contributing

Field initialization

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

return \GetOlympus\Dionysos\Field\Rte::build('my_rte_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.',

    /**
     * RTE settings
     * @see https://codex.wordpress.org/Function_Reference/wp_editor
     */
    'settings' => [
        'teeny'         => false,
        'textarea_rows' => 8,
    ]
]);

Variables definition

Variable	Type	Default value	Accepted value	Description
`title`	String	`'Rte'`	empty
`default`	String	empty	empty	Sets default value if none found
`description`	String	empty	empty
`settings`	Array	see Field initialization	see WordPress reference	For `rte` mode only

Retrive data

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

// Get RTE from Database
$rte = get_option('my_rte_field_id', '');

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

Release History

Version	Note
0.0.1	Initial commit

Contributing

Fork it (https://github.com/GetOlympus/olympus-dionysos-field-rte/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-rte

Maintainers

Details