getolympus/olympus-color-field

This package is abandoned and no longer maintained. The author suggests using the getolympus/olympus-dionysos-field-color package instead.

Color field, this component is a part of the Olympus Dionysos fields.

v0.0.13 2020-03-22 15:14 UTC

Requires (Dev)

• phpunit/phpunit: ~5.3

MIT

• Achraf Chouk

• framework
• php
• wordpress
• color
• custom
• field
• olympus
• dionysos

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

Variable	Type	Default value if not set	Accepted values
title	String	'Color'	empty
default	String	empty	Hex color code
description	String	empty	empty
settings	Array	see Field initialization	see WordPress reference

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

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