All notable changes to this project will be documented in this file.
- Use the more appropriate
add_meta_boxes
hook for hooking in metaboxes to post-edit screen. Thanks @inspiraaz for reporting. (#161) - Add a
row_classes
field param which allows you to add additional classes to the cmb-row wrap. This parameter can take a string, or array, or can take a callback that returns a string or array. The callback will receive$field_args
as the first argument, and the CMB2_Field$field
object as the second argument. Reported/requested in #68. - New constant,
CMB2_LOADED
, which you can use to check if CMB2 is loaded for your plugins/themes with CMB2 dependency. - New hooks,
cmb2_init_before_hookup
andcmb2_after_init
. - New API for adding metaboxes and fields, demonstrated in
example-functions.php
. In keeping with backwards-compatibility, thecmb2_meta_boxes
filter method will still work, but is not recommended. New API includesnew_cmb2_box
helper function to generate a new metabox, and returns a$cmb
object to add new fields (via theCMB2::add_field()
andCMB2::add_group_field()
methods). - New CMB2 method,
CMB2::remove_field()
. - New CMB2_Boxes method,
CMB2_Boxes::remove()
. - When clicking on a file/image in the
file
, orfile_list
type, the media modal will open with that image selected. Props johnsonpaul1014, (#120).
2.0.1 is the official version after beta, and includes all the changes from 2.0.0 (beta).
2.0.0 is the official version number for the transition to CMB2, and 2.0.1 is the official version after beta. It is a complete rewrite. Improvements and fixes are listed below. Note: This release requires WordPress 3.8+
- Converted
<table>
markup to more generic<div>
markup to be more extensible and allow easier styling. - Much better handling and display of repeatable groups.
- Entirely translation-ready with full translations in Spanish, French (Props @fredserva - #127), Finnish (Props @onnimonni - #108), Swedish (Props @EyesX - #141), and English.
- Add cmb fields to new user page. Props GioSensation, (#645).
- Improved and additional helper-functions.
- Added new features and translation for datepicker. Props kalicki, (#657).
- General code standards cleanup. Props gregrickaby, (#17 & others).
- Use SASS for development. Props gregrickaby, (#18).
- New
hidden
field type. - Ability to override text strings in fields via field options parameter.
- Added composer.json. Props nlemoine, (#19).
- New field 'hooks' can take static text/html or a callback.
- New
preview_size
parameter forfile
field type. Takes an array or named image size. - Empty index.php file to all folders (for more security). Props brunoramalho, (#41).
- Clean up styling. Props brunoramalho, (#43) and senicar.
- Collapsible field groups. Props cluke009, (#59).
- Allow for override of update/remove for CMB2_Field. Props sc0ttkclark, (#65).
- Use class button-disabled instead of disabled="disabled" for buttons. Props sc0ttkclark, (#66).
- New before/after dynamic form hooks.
- Larger unit test coverage. Props to @pmgarman for assistance. (#90 and #91)
- Added helper function to update an option. Props mAAdhaTTah, (#110).
- More JS hooks during repeat group shifting. Props AlchemyUnited, (#125).
- New metabox config option for defaulting to closed.
- New hooks,
cmb2_init
andcmb2_init_{$cmb_id}
.
- New mechanism to ensure CMB2 only loads the most recent version of CMB2 in your system. This fixes the issue where another bundled version could conflict or take precendent over your up-to-date version.
- Fix issue with field labels being hidden. Props mustardBees, (#48).
- Address issues with autoloading before autoloader is setup. Props JPry, (#56).
- Fixed 'show_on_cb' for field groups. Props marcusbattle, (#98).
- Make get_object_terms work with and without object caching. Props joshlevinson, (#105).
- Don't use
__DIR__
in example-functions.php to ensure PHP 5.2 compatibility. Props bryceadams, (#129). - Added support for radio input swapping in repeatable fields. Props DevinWalker, (#138, #149).
- Fix metabox form not being returned to caller. Props akshayagarwal, (#145).
- Run stripslashes before saving data, since WordPress forces magic quotes. Props clifgriffin, (#162).
- Localize Date, Time, and Color picker defaults so that they can be overridden via the
cmb_localized_data
filter. (#528) - Change third parameter for 'cmb_metabox_form' to be an args array. Optional arguments include
echo
,form_format
, andsave_button
. - Add support for
show_option_none
argument fortaxonomy_select
andtaxonomy_radio
field types. Also adds the following filters:cmb_all_or_nothing_types
,cmb_taxonomy_select_default_value
,cmb_taxonomy_select_{$this->_id()}_default_value
,cmb_taxonomy_radio_{$this->_id()}_default_value
,cmb_taxonomy_radio_default_value
. Props @pmgarman, (#569). - Make the list items in the
file_list
field type drag & drop sortable. Props twoelevenjay, (#603).
- Fixed typo in closing
</th>
tag. Props @CivicImages. (#616)
- Add support for custom date/time formats. Props @Scrent. (#506)
- Simplify
wysiwyg
escaping and allow it to be overridden via theescape_cb
parameter. (#491) - Add a 'Select/Deselect all' button for the
multicheck
field type. - Add title option for repeatable groups. Title field takes an optional replacement hash, "{#}" that will be replaced by the row number.
- New field parameter,
show_on_cb
, allows you to conditionally display a field via a callback. (#47) - Unit testing (the beginning). Props @brichards and @camdensegal.
- Fixed issue where remove file button wouldn't clear the url field. (#514)
wysiwyg
fields now allow underscores. Fixes some wysiwyg display issues in WordPress 3.8. Props @lswilson. (#491)- Nonce field should only be added once per page. (#521)
- Fix
in_array
issue when a post does not have any saved terms for a taxonomy multicheck. (#527) - Fixed error: 'Uninitialized string offset: 0 in cmb_Meta_Box_field.php...`. Props @DevinWalker. (#539, #549))
- Fix missing
file
field description. (#543, #547)
- Update
cmb_get_field_value
function as it was passing the parameters tocmb_get_field
in the wrong order. - Fix repeating fields not working correctly if meta key or prefix contained an integer. (#503)
- Fix issue with
cmb_Meta_Box_types.php
calling a missing method,image_id_from_url
. (#502)
- Radio button values were not showing saved value. (#500)
- Repeatable groups
- Support for more fields to be repeatable, including oEmbed field, and date, time, and color picker fields, etc.
- Codebase has been revamped to be more modular and object-oriented.
- New filter,
"cmb_{$element}_attributes"
for modifying an element's attributes. - Every field now supports an
attributes
parameter that takes an array of attributes. Read more. - Removed
cmb_std_filter
in favor ofcmb_default_filter
. THIS IS A BREAKING CHANGE - Better handling of labels in sidebar. They are now placed on top of the input rather than adjacent.
- Added i18n compatibility to text_money. props @ArchCarrier, (#485)
- New helper functions:
cmb_get_field
andcmb_get_field_value
for getting access to CMB's field object and/or value. - New JavaScript events,
cmb_add_row
andcmb_remove_row
for hooking in and manipulating the new row's data. - New filter,
cmb_localized_data
, for modifiying localized data passed to the CMB JS.
- Resolved occasional issue where only the first character of the label/value was diplayed. props @mustardBees, (#486)
- Change the way the
'cmb_validate_{$field['type']}'
filter works. It is now passed a null value vs saved value. If null is returned, default sanitization will follow. THIS IS A BREAKING CHANGE. If you're already using this filter, take note. - All field types that take an option array have been simplified to take
key => value
pairs (vsarray( 'name' => 'value', 'value' => 'key', )
). This effects the 'select', 'radio', 'radio_inline' field types. The 'multicheck' field type was already using thekey => value
format. Backwards compatibility has been maintained for those using the older style. - Added default value option for
taxonomy_select
field type. props @darlantc, (#473) - Added
preview_size
parameter forfile_list
field type. props @IgorCode, (#471) - Updated
file_list
images to be displayed horizontally instead of vertically. props @IgorCode, (#467) - Use
get_the_terms
where possible since the data is cached.
- Fixed wysiwyg escaping slashes. props @gregrickaby, (#465)
- Replaced
__DIR__
, asdirname( __FILE__ )
is easier to maintain back-compatibility. - Fixed missing table styling on new posts. props @mustardBees, (#438)
- Fix undeclared JS variable. @veelen, (#451)
- Fix
file_list
errors when removing all files and saving. - Set correct
object_id
to be used later incmb_show_on
filter. @lauravaq, (#445) - Fix sanitization recursion memeory issues.
- Now works with option pages and site settings. (view example in wiki)
- two filters to override the setting and getting of options,
cmb_override_option_get_$option_key
andcmb_override_option_save_$option_key
respectively. Handy for using plugins like WP Large Options (also here). - Improved styling on taxonomy (*tease*) and options pages and for new 3.8 admin UI.
- New sanitization class to sanitize data when saved.
- New callback field parameter,
sanitization_cb
, for performing your own sanitization. - new
cmb_Meta_Box_types::esc()
method that handles escaping data for display. - New callback field parameter,
escape_cb
, for performing your own data escaping, as well as a new filter,'cmb_types_esc_'. $field['type']
.
- Fixed wysiwyg editor button padding. props @corvannoorloos, (#391)
- A few php < 5.3 errors were addressed.
- Fields with quotation marks no longer break the input/textarea fields.
- metaboxes for Attachment pages now save correctly. Thanks @nciske for reporting. (#412)
- Occasionally fields wouldn't save because of the admin show_on filter.
- Smaller images loaded to the file field type will no longer be blown up larger than their dimensions.
- Added
text_datetime_timestamp_timezone
type, a datetime combo field with an additional timezone drop down, props @dessibelle - Added
select_timezone
type, a standalone time zone select dropdown. The time zone select can be used with standalonetext_datetime_timestamp
if desired. Props @dessibelle - Added
text_url
type, a basic url field. Props @dessibelle - Added
text_email
type, a basic email field. Props @dessibelle - Added ability to display metabox fields in frontend. Default is true, but can be overriden using the
cmb_allow_frontend filter
. If set to true, an entire metabox form can be output with thecmb_metabox_form( $meta_box, $object_id, $echo )
function. Props @dessibelle, @messenlehner & @jtsternberg. - Added hook
cmb_after_table
after all metabox output. Props @wpsmith file_list
now works like a repeatable field. Add as many files as you want. Props @coreymcollinstext
,text_small
,text_medium
,text_url
,text_email
, &text_money
fields now all have the option to be repeatable. Props @jtsternberg- Custom metaboxes can now be added for user meta. Add them on the user add/edit screen, or in a custom user profile edit page on the front-end. Props @tw2113, @jtsternberg
- Added field "before" and "after" options for each field. Solves issue with '$' not being the desired text_money monetary symbol, props @GaryJones
- Added filter for 'std' default fallback value, props @messenlehner
- Ensure oEmbed videos fit in their respective metaboxes, props @jtsternberg
- Fixed issue where an upload field with 'show_names' disabled wouldn't have the correct button label, props @jtsternberg
- Better file-extension check for images, props @GhostToast
- New filter,
cmb_valid_img_types
, for whitelisted image file-extensions, props @jtsternberg
- Added field type and field id classes to each cmb table row, props @jtsternberg
- Added post type comparison to prevent storing null values for taxonomy selectors, props @norcross
- Added
oEmbed
field type with ajax display, props @jtsternberg
- Note: This release requires WordPress 3.3+
- Cleaned up scripts being queued, props @jaredatch
- Cleaned up and reorganized jQuery, props @GaryJones
- Use $pagenow instead of custom $current_page, props @jaredatch
- Fixed CSS, removed inline styles, now all in style.css, props @jaredatch
- Fixed multicheck issues (issue #48), props @jaredatch
- Fixed jQuery UI datepicker CSS conflicting with WordPress UI elements, props @jaredatch
- Fixed zeros not saving in fields, props @GaryJones
- Fixed improper labels on radio and multicheck fields, props @jaredatch
- Fixed fields not rendering properly when in sidebar, props @jaredatch
- Fixed bug where datepicker triggers extra space after footer in Firefox (issue #14), props @jaredatch
- Added jQuery UI datepicker packaged with 3.3 core, props @jaredatch
- Added date time combo picker, props @jaredatch
- Added color picker, props @jaredatch
- Added readme.md markdown file, props @jaredatch
- Added jQuery timepicker, props @norcross
- Added 'raw' textarea to convert special HTML entities back to characters, props @norcross
- Added missing examples on example-functions.php, props @norcross
- Added the new wp_editor() function for the WYSIWYG dialog box, props @jcpry
- Created 'cmb_show_on' filter to define your own Show On Filters, props @billerickson
- Added page template show_on filter, props @billerickson
- Improvements to the 'file' field type, props @randyhoyt
- Allow for default values on 'radio' and 'radio_inline' field types, props @billerickson
- Enabled the ability to define your own custom field types (issue #28). props @randyhoyt
- Added the ability to limit metaboxes to certain posts by id. props @billerickson
- Fixed define to prevent notices. props @destos
- Added text_date_timestap option. props @andrewyno
- Fixed WYSIWYG paragraph breaking/spacing bug. props @wpsmith
- Added taxonomy_radio and taxonomies_select options. props @c3mdigital
- Fixed script causing the dashboard widgets to not be collapsible.
- Fixed various spacing and whitespace inconsistencies
- Think we have a release that is mostly working. We'll say the initial release :)