CMB2 Documentation
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hooks
  • Download Docs
  • Github

Packages

  • CMB2
  • Demo
    • CMB2
  • None
  • Tests
    • CMB2

Classes

  • CMB2
  • CMB2_Ajax
  • CMB2_Base
  • CMB2_Bootstrap_2101
  • CMB2_Boxes
  • CMB2_Display_Checkbox
  • CMB2_Display_Colorpicker
  • CMB2_Display_File
  • CMB2_Display_File_List
  • CMB2_Display_Multicheck
  • CMB2_Display_oEmbed
  • CMB2_Display_Select
  • CMB2_Display_Taxonomy_Multicheck
  • CMB2_Display_Taxonomy_Radio
  • CMB2_Display_Text_Date
  • CMB2_Display_Text_Date_Timezone
  • CMB2_Display_Text_Money
  • CMB2_Display_Text_Time
  • CMB2_Display_Text_Url
  • CMB2_Display_Textarea
  • CMB2_Display_Textarea_Code
  • CMB2_Field
  • CMB2_Field_Display
  • CMB2_Hookup
  • CMB2_Hookup_Base
  • CMB2_JS
  • CMB2_Option
  • CMB2_Options
  • CMB2_Options_Hookup
  • CMB2_REST
  • CMB2_REST_Controller
  • CMB2_REST_Controller_Boxes
  • CMB2_REST_Controller_Fields
  • CMB2_Sanitize
  • CMB2_Show_Filters
  • CMB2_Type_Base
  • CMB2_Type_Checkbox
  • CMB2_Type_Colorpicker
  • CMB2_Type_Counter_Base
  • CMB2_Type_File
  • CMB2_Type_File_Base
  • CMB2_Type_File_List
  • CMB2_Type_Multi_Base
  • CMB2_Type_Multicheck
  • CMB2_Type_Oembed
  • CMB2_Type_Picker_Base
  • CMB2_Type_Radio
  • CMB2_Type_Select
  • CMB2_Type_Select_Timezone
  • CMB2_Type_Taxonomy_Base
  • CMB2_Type_Taxonomy_Multicheck
  • CMB2_Type_Taxonomy_Multicheck_Hierarchical
  • CMB2_Type_Taxonomy_Radio
  • CMB2_Type_Taxonomy_Radio_Hierarchical
  • CMB2_Type_Taxonomy_Select
  • CMB2_Type_Taxonomy_Select_Hierarchical
  • CMB2_Type_Text
  • CMB2_Type_Text_Date
  • CMB2_Type_Text_Datetime_Timestamp
  • CMB2_Type_Text_Datetime_Timestamp_Timezone
  • CMB2_Type_Text_Time
  • CMB2_Type_Textarea
  • CMB2_Type_Textarea_Code
  • CMB2_Type_Title
  • CMB2_Type_Wysiwyg
  • CMB2_Types
  • CMB2_Utils
  • Test_CMB2_Utils_WIN

Functions

  • _tests_cmb2_manually_load_plugin
  • cmb2_ajax
  • cmb2_autoload_classes
  • cmb2_bootstrap
  • cmb2_dir
  • cmb2_do_oembed
  • cmb2_get_field
  • cmb2_get_field_value
  • cmb2_get_metabox
  • cmb2_get_metabox_form
  • cmb2_get_metabox_sanitized_values
  • cmb2_get_oembed
  • cmb2_get_option
  • cmb2_metabox_form
  • cmb2_options
  • cmb2_print_metabox_form
  • cmb2_update_option
  • cmb2_utils
  • date_create_from_format
  • date_timestamp_get
  • new_cmb2_box

Hooks

  • Hook Reference

Package CMB2

Classes summary

CMB2 The main CMB2 object for storing box data/properties.
CMB2_Ajax

CMB2 ajax methods (i.e. a lot of work to get oEmbeds to work with non-post objects)

CMB2_Base CMB2 Base - Base object functionality.
CMB2_Bootstrap_2101 Handles checking for and loading the newest version of CMB2
CMB2_Boxes A CMB2 object instance registry for storing every CMB2 instance.
CMB2_Display_Checkbox CMB2 field display base.
CMB2_Display_Colorpicker CMB2 field display base.
CMB2_Display_File CMB2 field display base.
CMB2_Display_File_List CMB2 field display base.
CMB2_Display_Multicheck CMB2 field display base.
CMB2_Display_oEmbed CMB2 field display base.
CMB2_Display_Select CMB2 field display base.
CMB2_Display_Taxonomy_Multicheck CMB2 field display base.
CMB2_Display_Taxonomy_Radio CMB2 field display base.
CMB2_Display_Text_Date CMB2 field display base.
CMB2_Display_Text_Date_Timezone CMB2 field display base.
CMB2_Display_Text_Money CMB2 field display base.
CMB2_Display_Text_Time CMB2 field display base.
CMB2_Display_Text_Url CMB2 field display base.
CMB2_Display_Textarea CMB2 field display base.
CMB2_Display_Textarea_Code CMB2 field display base.
CMB2_Field CMB2 field objects
CMB2_Field_Display CMB2 field display base.
CMB2_Hookup

Handles hooking CMB2 forms/metaboxes into the post/attachement/user screens and handles hooking in and saving those fields.

CMB2_Hookup_Base Base class for hooking CMB2 into WordPress.
CMB2_JS Handles the dependencies and enqueueing of the CMB2 JS scripts
CMB2_Option

Handles getting/setting of values to an option array for a specific option key

CMB2_Options Retrieves an instance of CMB2_Option based on the option key
CMB2_Options_Hookup

Handles hooking CMB2 forms/metaboxes into the post/attachement/user screens and handles hooking in and saving those fields.

CMB2_REST

Handles hooking CMB2 objects/fields into the WordPres REST API which can allow fields to be read and/or updated.

CMB2_REST_Controller

Creates CMB2 objects/fields endpoint for WordPres REST API. Allows access to fields registered to a specific post type and more.

CMB2_REST_Controller_Boxes

CMB2 objects/boxes endpoint for WordPres REST API. Allows access to boxes configuration data.

CMB2_REST_Controller_Fields

CMB2 objects/fields endpoint for WordPres REST API. Allows access to fields registered to a specific box.

CMB2_Sanitize CMB2 field sanitization
CMB2_Show_Filters

Show On Filters Use the 'cmb2_show_on' filter to further refine the conditions under which a metabox is displayed. Below you can limit it by ID and page template

CMB2_Type_Base CMB base field type
CMB2_Type_Checkbox CMB checkbox field type
CMB2_Type_Colorpicker CMB colorpicker field type
CMB2_Type_Counter_Base CMB base field type
CMB2_Type_File CMB file field type
CMB2_Type_File_Base CMB File base field type
CMB2_Type_File_List CMB file_list field type
CMB2_Type_Multi_Base CMB Multi base field type
CMB2_Type_Multicheck CMB multicheck field type
CMB2_Type_Oembed CMB oembed field type
CMB2_Type_Picker_Base CMB Picker base field type
CMB2_Type_Radio CMB radio field type
CMB2_Type_Select CMB select field type
CMB2_Type_Select_Timezone CMB select_timezone field type
CMB2_Type_Taxonomy_Base CMB Taxonomy base field type
CMB2_Type_Taxonomy_Multicheck CMB taxonomy_multicheck field type
CMB2_Type_Taxonomy_Multicheck_Hierarchical CMB taxonomy_multicheck_hierarchical field type
CMB2_Type_Taxonomy_Radio CMB taxonomy_radio field type
CMB2_Type_Taxonomy_Radio_Hierarchical CMB taxonomy_radio_hierarchical field type
CMB2_Type_Taxonomy_Select CMB taxonomy_select field type
CMB2_Type_Taxonomy_Select_Hierarchical CMB taxonomy_select_hierarchical field type
CMB2_Type_Text CMB text field type
CMB2_Type_Text_Date CMB text_date field type
CMB2_Type_Text_Datetime_Timestamp CMB text_datetime_timestamp field type
CMB2_Type_Text_Datetime_Timestamp_Timezone CMB text_datetime_timestamp_timezone field type
CMB2_Type_Text_Time CMB text_time field type
CMB2_Type_Textarea CMB textarea field type
CMB2_Type_Textarea_Code CMB textarea_code field type
CMB2_Type_Title CMB title field type
CMB2_Type_Wysiwyg CMB wysiwyg field type
CMB2_Types CMB field type objects
CMB2_Utils CMB2 Utilities
Test_CMB2_Utils_WIN CMB2 Utilities

Functions summary

_tests_cmb2_manually_load_plugin Activates the CMB2 plugin in WordPress so it can be tested.
cmb2_ajax Get instance of the CMB2_Ajax class
cmb2_autoload_classes Autoloads files with CMB2 classes when needed
cmb2_bootstrap Function to encapsulate the CMB2 bootstrap process.
cmb2_dir Helper function to provide directory path to CMB2
cmb2_do_oembed Outputs the return of cmb2_get_oembed.
cmb2_get_field Get a CMB2 field object.
cmb2_get_field_value Get a field's value.
cmb2_get_metabox Retrieve a CMB2 instance by the metabox ID
cmb2_get_metabox_form Retrieve a metabox form
cmb2_get_metabox_sanitized_values Returns array of sanitized field values from a metabox (without saving them)
cmb2_get_oembed Get a cmb oEmbed. Handles oEmbed getting for non-post objects
cmb2_get_option A helper function to get an option from a CMB2 options array
cmb2_metabox_form Display a metabox form (or optionally return it) & save it on submission.
cmb2_options Get instance of the CMB2_Option class for the passed metabox ID
cmb2_print_metabox_form Display a metabox form & save it on submission
cmb2_update_option A helper function to update an option in a CMB2 options array
cmb2_utils Get instance of the CMB2_Utils class
date_create_from_format

Reimplementation of DateTime::createFromFormat for PHP < 5.3. :( Borrowed from http://stackoverflow.com/questions/5399075/php-datetimecreatefromformat-in-5-2

date_timestamp_get

Returns the Unix timestamp representing the date. Reimplementation of DateTime::getTimestamp for PHP < 5.3. :(

new_cmb2_box Because OOP can be scary
CMB2 Documentation API documentation generated by ApiGen