Colorpicker Custom Field

Overview

This Default Field Type is available in WordPress Creation Kit free version. The Colorpicker Field allows a color to be selected via a JavaScript popup.

Creating a Colorpicker Field

To add a Colorpicker Field to a previously created Custom Meta Box, under the Meta Box Fields tab simply insert a Field Title and under Field Type make sure you select Colorpicker.

The Colorpicker Field contains options to customize it:

1. Description – Allows you to specify a description for the Colorpicker Field
2. Required – Select whether or not the field is required
3. Default Value – Set a default value for the field

Page, Post or Custom Post Type Edit Screen

This is how the Colorpicker Field we created above looks like in the Edit Screen:

Template usage

The following examples are for a Custom Meta Box with the “Group Name” argument “my_meta_name“. Make sure to replace this with the “Group Name” you have set up. The Custom Meta Box below is setup to be attached to a post.

Using the WCK Custom Fields API

The Colorpicker Field returns a string containg the hex color code.

For a Single Meta Box

To output a value inside The Loop we use the function the_cfc_field():

1

Value: <!--?php the_cfc_field('my_meta_name', 'my-color'); ?-->

To assign the value to a variable we use the function get_cfc_field():

1

<!--?php $first_color = get_cfc_field('my_meta_name', 'my-color'); ?-->

For a Repeater Meta Box

To output all the “My Color” entries from the repeater field we use the functions get_cfc_meta() and the_cfc_field():

1

<!--?php foreach( get_cfc_meta( 'my_meta_name' ) as $key =&gt; $value ){ the_cfc_field( 'my_meta_name','my-color', false, $key ); } ?-->

To output a specific “My Color” entry from the repeater field (e.g. the second entry), we use the function the_cfc_field():

1

<!--?php the_cfc_field( 'my_meta_name','my-color', false, 1 ); ?-->

The index starts at 0 so that’s why we pass “1” to the function. For the first entry it would be “0”, the second is “1”, the third is “2” and so on…

Using the default WordPress functions

For a Single Meta Box

1

<!--?php $my_meta = get_post_meta( $post-&gt;ID, 'my_meta_name', true ); if( !empty( $my_meta[0]['my-color'] ) ) echo 'Value:'.$my_meta[0]['my-color']; ?-->

For a Repeater Meta Box

To output all the “My Color” entries in the repeater field:

1

<!--?php $my_meta = get_post_meta( $post-&gt;ID, 'my_meta_name', true ); if( !empty( $my_meta ) ){ foreach( $my_meta as $entry ){ echo $entry['my-color']; } } ?-->

To output a specific “My Color” entry from the repeater field (e.g. the second entry):

1

<!--?php $my_meta = get_post_meta( $post-&gt;ID, 'my_meta_name', true ); if( !empty( $my_meta[1]['my-color'] ) ) echo $my_meta[1]['my-color']; ?-->

The index starts at 0 so that’s why we pass “1” to the function. For the first entry it would be “0”, the second is “1”, the third is “2” and so on…

After version 2.0 we can also get fields directly

1

<!--?php /* get the first entry */ $first_value = get_post_meta( $post-&gt;ID, 'my-color', true ); /* get the third entry */ $third_value = get_post_meta( $post-&gt;ID, 'my-color_2', true ); ?-->

• Share:
• Facebook
• Twitter
• Linkedin