README

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

composer require getolympus/olympus-dionysos-field-color

Field initialization

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

return \GetOlympus\Dionysos\Field\Color::build('my_color_field_id', [
    'title'       => 'What is your favorite Coke?',
    'default'     => '#f40000',
    'description' => 'Zero and Light are not available colors!',

    /**
     * Color picker settings
     * @see https://core.trac.wordpress.org/browser/trunk/src/js/_enqueues/lib/color-picker.js
     */
    'settings' => [
        'defaultColor' => false,
        'hide'         => true,
        'palettes'     => true,
        'width'        => 255,
        'mode'         => 'hsv',
        'type'         => 'full',
        'slider'       => 'horizontal',
    ],
]);

Variables definitions

Retrive data

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

// Get color from Database
$color = get_option('my_color_field_id', '#f40000');

// Display Coca-Cola baseline in color
echo 'Always <b style="color:'.$color.'">Coca-Cola</b>';

Release History

0.0.13

Use default getVars Zeus-Core method. No need to override it anymore

0.0.12

New Olympus components compatibility
Change repository to be a part of Dionysos fields

0.0.11

FIX: json encoder in twig source file

Contributing

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

Maintainers

Details