CMB2

Contributors: webdevstudios, jtsternberg, gregrickaby, tw2113, patrickgarman
Donate link: http://webdevstudios.com
Tags: metaboxes, forms, fields, options, settings
Requires at least: 3.8.0
Tested up to: 4.1.0
Stable tag: 2.0.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Complete contributors list found here: github.com/WebDevStudios/CMB2/graphs/contributors

Description

CMB2 is a metabox, custom fields, and forms library for WordPress that will blow your mind.

Plugin available on wordpress.org

CMB2 is a complete rewrite of Custom Metaboxes and Fields for WordPress. To get started, please follow the examples in the included example-functions.php file and have a look at the basic usage instructions.

You can see a list of available field types here.

Features:

• Create metaboxes to be used on post edit screens.
• Create forms to be used on an options pages.
• Create forms to handle user meta and display them on user profile add/edit pages.
• Flexible API that allows you to use CMB forms almost anywhere, even on the front-end.
• Several field types are included.
• Custom API hook that allows you to create your own field types.
• There are numerous hooks and filters, allowing you to modify many aspects of the library (without editing it directly).
• Repeatable fields for most field types are supported, as well as repeatable field groups.
• CMB2 is safe to bundle with any project. It will only load the newest version in the system.

Translation

• Thanks to many in the CMB2 community and to our friends at wp-translations.org, we have a good start on several translations for CMB2. Please feel free to work with wp-translations.org to provide even more!

3rd Party Resources

Custom Field Types

• CMB2 Field Type: CMB Attached Posts Field from coreymcollins: custom_attached_posts, for attaching posts to a page.

• CMB2 Field Type: CMB2 Post Search field: post_search_text adds a post-search dialog for searching/attaching other post IDs.

• CMB2 Field Type: CMB2 RGBa Colorpicker from JayWood: rgba_colorpicker adds a color picker that supports RGBa, (RGB with transparency (alpha) value).

• CMB2 Field Type: Google Maps from mustardBees: Custom field type for Google Maps.

  The pw_map field stores the latitude/longitude values which you can then use to display a map in your theme.

• CMB2 Field Type: Select2 from mustardBees: Custom field types which use the Select2 script:

  1. The pw_select field acts much like the default select field. However, it adds typeahead-style search allowing you to quickly make a selection from a large list
  2. The pw_multiselect field allows you to select multiple values with typeahead-style search. The values can be dragged and dropped to reorder

• CMB2 Field Type: Gallery from mustardBees: Adds a WordPress gallery field.

• CMB Field Type: Slider from mattkrupnik: Adds a jQuery UI Slider field.

Other Helpful Resources

• Taxonomy_MetaData: WordPress Helper Class for saving pseudo-metadata for taxonomy terms. Includes an extended class for using CMB to generate the actual form fields.
• WordPress Shortcode Button: Uses CMB2 fields to generate fields for shortcode input modals.

Contribution

All contributions welcome. If you would like to submit a pull request, please check out the trunk branch and pull request against it. Please read the CONTRIBUTING doc for more details.

A complete list of all our awesome contributors found here: github.com/WebDevStudios/CMB2/graphs/contributors

Links

• Github project page
• Documentation (GitHub wiki)

Installation

If installing the plugin from wordpress.org:

1. Upload the entire /CMB2 directory to the /wp-content/plugins/ directory.
2. Activate CMB2 through the 'Plugins' menu in WordPress.
3. Copy (and rename if desired) example-functions.php into to your theme or plugin's directory.
4. Edit to only include the fields you need and rename the functions.
5. Profit.

If including the library in your plugin or theme:

1. Place the CMB2 directory inside of your theme or plugin.
2. Copy (and rename if desired) example-functions.php into a folder above the CMB2 directory OR copy the entirety of its contents to your theme's functions.php file.
3. Edit to only include the fields you need and rename the functions (CMB2 directory should be left unedited in order to easily update the library).
4. Profit.

2.0.3

Enhancements

• New constant, CMB2_DIR, which stores the file-path to the CMB2 directory.
• text_date, text_time, text_date_timestamp, text_datetime_timestamp, and text_datetime_timestamp_timezone field types now take an arguments array so they can be extended by custom field types.
• Removed auto-scroll when adding groups. To re-add the feature, use the snippet/plugin here. (#205)
• Updated Timepicker utilizing the @trentrichardson jQuery Timepicker add-on (https://github.com/trentrichardson/jQuery-Timepicker-Addon), and updated Datepicker styles. Props JonMasterson. (#204, #206, #45).
• Added a callback option for the field default value. The callback gets passed an array of all the field parameters as the first argument, and the field object as the second argument. (which means you can get the post id using $field->object_id). (#233).
• New CMB2::get_field() method and cmb2_get_field helper function for retrieving a CMB2_Field object from the array of registered fields for a metabox.
• New CMB2::get_sanitized_values() method and cmb2_get_metabox_sanitized_values helper function for retrieving sanitized values from an array of values (usually $_POST data).
• New 'save_fields' metabox property that can be used to disable (by setting 'save_fields' => false) the automatic saving of the fields when the form is submitted. These can be useful when you want to handle the saving of the fields yourself, or want to use submitted data for other purposes like generating new posts, or sending emails, etc.

Bug Fixes

• Fix commented out text_datetime_timestamp_timezone field registration example in example-functions.php. Props cliffordp, (#203).
• Fix sidebar styling for money fields and fields with textareas. (#234)
• Fix CMB2_Sanitize class to properly use the stripslashed value (which was added in #162 but never used). Props dustyf, (#241).

View complete changelog

Known Issues

• The CMB2 url (for css/js resources) does not define properly in all WAMP/XAMP (Windows) environments.
• Metabox containing WYSIWYG editor cannot be moved or used in a repeatable way at this time (this is a TinyMCE issue).
• Not all fields work well in a repeatable group.