getolympus / olympus-code-field
Code field, this component is a part of the Olympus Dionysos fields.
Installs: 423
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Type:olympus-field
Requires (Dev)
- phpunit/phpunit: ~5.3
README
Dionysos Code Field
This component is a part of the Olympus Dionysos fields for WordPress.
It uses the default WordPress code field made with a complete integration with codemirror JS component.
composer require getolympus/olympus-dionysos-field-code
Table of contents
Field initialization • Variables definition • Accepted mode • Retrive data • Release History • Contributing
Field initialization
Use the following lines to add a code field
in your WordPress admin pages or custom post type meta fields:
return \GetOlympus\Dionysos\Field\Code::build('my_code_field_id', [ 'title' => 'How do Penguins code their icebergs?', 'default' => 'With a frozen bug.', 'description' => 'A simple question to let you know how to seduce a penguin.', 'mode' => 'json', 'rows' => 4, /** * Code mirror settings * @see https://developer.wordpress.org/reference/functions/wp_get_code_editor_settings/ */ 'settings' => [ 'indentUnit' => 2, 'indentWithTabs' => false, 'tabSize' => 2, ], ]);
Variables definition
Variable | Type | Default value if not set | Accepted values |
---|---|---|---|
title |
String | 'Code' |
empty |
default |
String | empty | empty |
description |
String | empty | empty |
mode |
String | text/html |
see Accepted mode |
rows |
Integer | 4 |
> 1 |
settings |
Array | see Field initialization | see WordPress reference |
Accepted mode
text/css
orcss
text/x-diff
orx-diff
ordiff
text/html
orhtml
text/javascript
orjavascript
orjs
application/json
orjson
text/x-markdown
ormarkdown
ormd
application/x-httpd-php
orx-httpd-php
orphp
text/x-python
orx-python
orpython
text/x-ruby
orx-ruby
orruby
text/x-sh
orx-sh
orsh
text/x-mysql
orx-mysql
ormysql
text/x-mariadb
orx-mariadb
ormariadb
application/xml
orxml
text/x-yaml
orx-yaml
oryaml
Usage example
Fill the form properly (with JSON in this example):
{ "response": "With a frozen bug." }
Retrive data
Retrieve your value from Database with a simple get_option('my_code_field_id', '')
(see WordPress reference):
// Get code from Database $code = get_option('my_code_field_id', ''); // Display code in HTML tag echo '<pre>'.htmlspecialchars($code).'</pre>';
Release history
Version | Note |
---|---|
0.0.14 | Fix jQuery integration on domReady |
0.0.13 | Add new CodeMirror css for widget integration |
0.0.12 | New Olympus components compatibility Change repository to be a part of Dionysos fields |
Contributing
- Fork it (https://github.com/GetOlympus/olympus-dionysos-field-code/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.