getolympus / olympus-content-field
Content field, this component is a part of the Olympus Dionysos fields.
Installs: 147
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:olympus-field
Requires (Dev)
- phpunit/phpunit: ~5.3
README
This component is a part of the Olympus Dionysos fields for WordPress.
composer require getolympus/olympus-dionysos-field-content
Field initialization
Use the following lines to add a content field
in your WordPress admin pages or custom post type's meta fields:
Note the $identifier
(first ::build()
parameter) is set to false
because no value is stored in database.
return \GetOlympus\Dionysos\Field\Content::build(false, [ 'title' => 'The Dark Knight', 'content' => '', 'debug' => false, 'file' => 'im_the_batman.php', 'vars' => [ 'question' => 'Who\'s the Batman?', 'answers' => [ 'the-joker' => 'The Joker', 'harley-quinn' => 'Harley Quinn', 'bruce-wayne' => 'Bruce Wayne, don\'t tell anybody!', 'gotham-city' => 'Gotham City', ], ], ]);
Variables definitions
Variable | Type | Default value if not set | Accepted values |
---|---|---|---|
title |
String | 'File contents' |
empty |
content |
String | empty | empty |
debug |
Bookean | empty | empty |
file |
String | false |
true or false |
vars |
Array | empty | empty |
Notes:
- Set
content
to display HTML tags. It can be used as a fallback if file doesn't exist - Set
debug
totrue
to enable the debug mode in case file inclusion fail - Set
file
to define the PHP file path to include asinclude_once
PHP function
Vars usage
In the included file (im_the_batman.php
in this example), you can use the $v
variable as an array:
// Display question echo '<h2>'.stripslashes($v['question']).'</h2>'; echo '<ul>'; // Display answers choices with radio button foreach ($v['answers'] as $k => $answer) { echo '<li class="'.$k.' is-the-batman">'.stripslashes($answer).'</li>'; } echo '</ul>';
Content display priority
The component will display, by priority:
- included
file
path - everything in
content
Note: do not forget to set debug
to true
to display an error in the case the file
does not exist or is not readable.
Release History
0.0.12
- Remove useless description
0.0.11
- New Olympus components compatibility
- Change repository to be a part of Dionysos fields
0.0.10
- FIX: content raw display on twig file
Contributing
- Fork it (https://github.com/GetOlympus/olympus-dionysos-field-content/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.