Skip to content

Διώνυσος — Toggle field, this component is a part of the Olympus Dionysos fields for WordPress.

License

Notifications You must be signed in to change notification settings

GetOlympus/olympus-dionysos-field-toggle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dionysos Toggle Field

Olympus Component CodeFactor Grade Packagist Version MIT

This component is a part of the Olympus Dionysos fields for WordPress.

composer require getolympus/olympus-dionysos-field-toggle

Table of contents

Field initializationVariables definitionRetrive dataRelease historyContributing


Field initialization

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

return \GetOlympus\Dionysos\Field\Toggle::build('my_toggle_field_id', [
    'title'       => 'Get ready to rumble!',
    'default'     => true,
    'description' => 'Put it on to get started',
]);

Variables definition

Variable Type Default value if not set Accepted values
title String 'Toggle' empty
default Boolean false true or false
description String empty empty

Retrive data

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

// Get toggle from Database
$toggle = get_option('my_toggle_field_id', false);

// Display toggle in HTML tag
echo $toggle ? 'Let\'s go!' : 'Not ready yet.';

Release history

Version Note
0.0.16 Use WordPress default design to display toggle box
0.0.15 Use default getVars Zeus-Core method. No need to override it anymore
0.0.14 New Olympus components compatibility
Change repository to be a part of Dionysos fields

Contributing

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

About

Διώνυσος — Toggle field, this component is a part of the Olympus Dionysos fields for WordPress.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published