CMB2 2.13.5 has 23 actions and 61 filters, read directly from its source code on Nov 17, 2026. The list updates automatically when a new version is released.
How to use these hooks
Actions let you run your own code at a specific moment. Filters let you change a value before the plugin uses it. Put your code in a child theme's functions.php or a code-snippets plugin, never in the plugin's own files, because updates overwrite them.
// Run your own code when CMB2 fires an action
add_action( 'cmb2_admin_init', function() {
// Your code runs here.
}, 10, 1 );
// Change a value CMB2 is about to use
add_filter( 'cmb2_rest_enforce_options_page_read_permissions', function( $value, $cmb ) {
// Change $value here.
return $value;
}, 10, 2 );Parts of a name in {braces} are filled in at runtime (for example a post type or field ID). Choose Example on any hook for a ready-to-edit snippet.
All hooks
-
/** * Whether to align options-page box REST reads with WordPress core's * settings/options convention (reads gated behind a capability). */ apply_filters( 'cmb2_rest_enforce_options_page_read_permissions', false, $cmb ); -
/** * Allows overloading the object (CMB2 or CMB2_Field) with additional * capabilities by registering hook callbacks. */ apply_filters_ref_array( "{$object_class}_inherit_{$method}", $args ); -
cmb2_{$element}_attributes
filter/** * Filter attributes for a field type. The dynamic portion of the hook name, * $element, refers to the field type. */ apply_filters( "cmb2_{$element}_attributes", $args, $type_defaults, $this->field, $this->types ); -
/** * Filter for determining if a field value has a valid image file-type * extension. */ apply_filters( "cmb2_{$field_id}_is_valid_img_ext", $is_valid, $file, $file_ext ); -
/** * Fires before fields have been processed/saved. */ do_action( "cmb2_{$object_type}_process_fields_{$this->cmb_id}", $this, $this->object_id() ); -
cmb2_admin_init
action/** * Fires on the admin side when CMB2 is included/loaded. */ do_action( 'cmb2_admin_init' ); -
/** * Hook after field row ends. */ do_action( "cmb2_after_{$field_type}_field_row", $this ); -
/** * Hook after form form has been rendered */ do_action( "cmb2_after_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); -
cmb2_after_field_row
action/** * Hook after field row ends. */ do_action( 'cmb2_after_field_row', $this ); -
cmb2_after_form
action/** * Hook after form form has been rendered */ do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this ); -
cmb2_after_init
action/** * Fires after CMB2 initiation process has been completed */ do_action( 'cmb2_after_init' ); -
/** * By default, no special permissions needed. */ apply_filters( 'cmb2_api_get_boxes_permissions_check', true, $this ); -
/** * Hook before field row begins. */ do_action( "cmb2_before_{$field_type}_field_row", $this ); -
/** * Hook before form table begins */ do_action( "cmb2_before_{$object_type}_form_{$this->cmb_id}", $object_id, $this ); -
cmb2_before_field_row
action/** * Hook before field row begins. */ do_action( 'cmb2_before_field_row', $this ); -
cmb2_before_form
action/** * Hook before form table begins */ do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this ); -
cmb2_can_save
filter/** * Filter to determine if metabox is allowed to save. */ apply_filters( 'cmb2_can_save', $can_save, $this->cmb ); -
/** * Filters the custom field display class used for displaying the field. Class * is required to extend CMB2_Type_Base. */ apply_filters( "cmb2_display_class_{$fieldtype}", $display_class_name, $field ); -
cmb2_enqueue_css
filter/** * Filter to determine if CMB2'S css should be enqueued. */ apply_filters( 'cmb2_enqueue_css', true ); -
cmb2_enqueue_js
filter/** * Filter to determine if CMB2'S JS should be enqueued. */ apply_filters( 'cmb2_enqueue_js', true ); -
cmb2_field_arguments
filter/** * Filter the CMB2 Field arguments after processing. */ apply_filters( 'cmb2_field_arguments', $args, $this ); -
cmb2_field_arguments_raw
filter/** * Filtering the CMB2 Field arguments once merged with the defaults, but before * further processing. */ apply_filters( 'cmb2_field_arguments_raw', $args, $this ); -
cmb2_field_defaults
filter/** * Filter the CMB2 Field defaults. */ apply_filters( 'cmb2_field_defaults', $defaults, $args['id'], $args['type'], $this ); -
cmb2_get_rest_value
filter/** * Filter the value before it is sent to the REST request. */ apply_filters( 'cmb2_get_rest_value', $value, $this ); -
/** * Filter the value before it is sent to the REST request. */ apply_filters( "cmb2_get_rest_value_{$field_type}", $value, $this ); -
/** * Filter the value before it is sent to the REST request. */ apply_filters( "cmb2_get_rest_value_for_{$field_id}", $value, $this ); -
cmb2_group_wrap_attributes
filter/** * Allow for adding additional HTML attributes to a group wrapper. */ apply_filters( 'cmb2_group_wrap_attributes', $group_wrap_attributes, $field_group ); -
cmb2_init
action/** * Fires when CMB2 is included/loaded */ do_action( 'cmb2_init' ); -
cmb2_init_{$this->cmb_id}
action/** * Hook during initiation of CMB2 object */ do_action( "cmb2_init_{$this->cmb_id}", $this ); -
cmb2_init_before_hookup
action/** * Fires after all CMB2 instances are created */ do_action( 'cmb2_init_before_hookup' ); -
/** * Initiates the box "hookup" into WordPress. */ do_action( "cmb2_init_hookup_{$cmb->cmb_id}", $cmb ); -
cmb2_meta_box_url
filter/** * Filter the CMB location url. */ apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION ); -
cmb2_meta_boxes
filter/** * For back-compat. Does the dirty-work of instantiating all the CMB2 instances * for the cmb2_meta_boxes filter */ apply_filters( 'cmb2_meta_boxes', array() ); -
cmb2_non_repeatable_fields
filter/** * Filter field types that are non-repeatable. */ apply_filters( 'cmb2_non_repeatable_fields', array() ); -
/** * Filter whether to override removing of meta value. */ apply_filters( "cmb2_override_{$a['field_id']}_meta_remove", $override, $a, $this->args(), $this ); -
/** * Filter and parameters are documented for 'cmb2_override_meta_save' filter * (above). */ apply_filters( "cmb2_override_{$a['field_id']}_meta_save", $override, $a, $this->args(), $this ); -
/** * Filter and parameters are documented for 'cmb2_override_meta_value' filter * (above). */ apply_filters( "cmb2_override_{$a['field_id']}_meta_value", $data, $this->object_id, $a, $this ); -
cmb2_override_meta_remove
filter/** * Filter whether to override removing of meta value. Returning a non-null * value will effectively short-circuit the function. */ apply_filters( 'cmb2_override_meta_remove', null, $a, $this->args(), $this ); -
cmb2_override_meta_save
filter/** * Filter whether to override saving of meta value. Returning a non-null value * will effectively short-circuit the function. */ apply_filters( 'cmb2_override_meta_save', null, $a, $this->args(), $this ); -
cmb2_override_meta_value
filter/** * Filter whether to override getting of meta value. Returning a non * 'cmb2_field_no_override_val' value will effectively short-circuit the value * retrieval. */ apply_filters( 'cmb2_override_meta_value', 'cmb2_field_no_override_val', $this->object_id, $a, $this ); -
/** * A filter to bypass the default display. */ apply_filters( "cmb2_pre_field_display_{$field_type}", null, $this, $display ); -
cmb2_render_{$fieldtype}
action/** * Pass non-existent field types through an action. */ do_action( "cmb2_render_{$fieldtype}", $this->field, $this->field->escaped_value(), $this->field->object_id, $this->field->object_type, $this ); -
/** * Filters the custom field type class used for rendering the field. Class is * required to extend CMB2_Type_Base. */ apply_filters( "cmb2_render_class_{$fieldtype}", $render_class_name, $this ); -
cmb2_repeat_table_row_types
filter/** * By default, 'text_url' and 'text' fields get table-like styling */ apply_filters( 'cmb2_repeat_table_row_types', array( 'text_url', 'text', ) ); -
/** * Whether CMB2 REST field reads of a user follow WordPress core's user read * permissions: core shows a user only to that user, to holders of * `edit_user`/`list_users`, or when the user has published posts. */ apply_filters( 'cmb2_rest_enforce_user_read_permissions', null, $cmb ); -
cmb2_rest_prepare
filter/** * Filter the prepared CMB2 item response. */ apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this ); -
/** * Filter whether 'taxonomy_*' fields should return their value when being * sanitized. */ apply_filters( "cmb2_return_taxonomy_values_{$cmb_id}", $return_values, $this ); -
cmb2_row_classes
filter/** * Globally filter row classes */ apply_filters( 'cmb2_row_classes', implode( ' ', $classes ), $this ); -
cmb2_sanitize_{$field_type}
filter/** * Filter the value before it is saved. */ apply_filters( "cmb2_sanitize_{$field_type}", null, $sanitizer->value, $this->object_id, $this->args(), $sanitizer ); -
/** * Fires after all fields have been saved. */ do_action( "cmb2_save_{$object_type}_fields", $object_id, $this->cmb_id, $this->updated, $this ); -
/** * Fires after all fields have been saved. */ do_action( "cmb2_save_{$object_type}_fields_{$this->cmb_id}", $object_id, $this->updated, $this ); -
cmb2_save_field
action/** * Hooks after save field action. */ do_action( 'cmb2_save_field', $field_id, $updated, $action, $this ); -
cmb2_save_field_{$field_id}
action/** * Hooks after save field action. */ do_action( "cmb2_save_field_{$field_id}", $updated, $action, $this ); -
cmb2_set_box_object_type
filter/** * Filter the metabox object type. */ apply_filters( 'cmb2_set_box_object_type', $mb_object_type, $found_type, $this ); -
cmb2_set_object_id
filter/** * Filter the object id. */ apply_filters( 'cmb2_set_object_id', $object_id, $this ); -
/** * Whether to auto-load the option when WordPress starts up. */ apply_filters( "cmb2_should_autoload_{$this->key}", true, $this ); -
cmb2_should_pre_enqueue
filter/** * Filter to determine if CMB2 should be pre-enqueued on the current page. */ apply_filters( 'cmb2_should_pre_enqueue', $should_pre_enqueue, $hook, $this ); -
cmb2_show_on
filter/** * Filter to determine if metabox should show. Default is true. */ apply_filters( 'cmb2_show_on', $show, $this->cmb->meta_box, $this->cmb ); -
/** * Filter to determine if the term's fields should show in the "Add term" * section. */ apply_filters( "cmb2_show_on_term_add_form_{$this->cmb->cmb_id}", $show_on_add, $this->cmb ); -
cmb2_style_dependencies
filter/** * Filters the registered style dependencies for the cmb2 stylesheet. */ apply_filters( 'cmb2_style_dependencies', array() ); -
/** * Default (option-none) taxonomy-radio value. */ apply_filters( "cmb2_taxonomy_radio_{$field_id}_default_value", $option_none_value ); -
/** * Default (option-none) taxonomy-radio value. */ apply_filters( 'cmb2_taxonomy_radio_default_value', '' ); -
/** * Default (option-none) taxonomy-select value. */ apply_filters( "cmb2_taxonomy_select_{$field_id}_default_value", $option_none_value ); -
/** * Default (option-none) taxonomy-select value. */ apply_filters( 'cmb2_taxonomy_select_default_value', '' ); -
cmb2_types_esc_{$field_type}
filter/** * Filter the value for escaping before it is ouput. */ apply_filters( "cmb2_types_esc_{$field_type}", null, $meta_value, $this->args(), $this ); -
cmb2_valid_img_types
filter/** * Which image types are considered valid image file extensions. */ apply_filters( 'cmb2_valid_img_types', $valid_types ); -
cmb2_wrap_classes
filter/** * Globally filter box wrap classes */ apply_filters( 'cmb2_wrap_classes', $classes, $this ); -
deprecated_argument_run
action/** * Fires when a deprecated argument is called. This is a WP core action. */ do_action( 'deprecated_argument_run', $function, $message, $version ); -
/** * Filters whether to trigger an error for deprecated arguments. This is a WP * core filter. */ apply_filters( 'deprecated_argument_trigger_error', true ); -
rest_the_post
filter/** * Filter the post. */ apply_filters( 'rest_the_post', $post_obj, $post ); -
cmb2_default_filter
filterapply_filters( 'cmb2_default_filter', $default, $this ); -
cmb2_validate_{$field_type}
filterapply_filters_deprecated( "cmb2_validate_{$field_type}", array( null, $this->value, $this->field->object_id, $this->field->args(), $this ), '2.0.0', "cmb2_sanitize_{$field_type}" ); -
cmb2_all_or_nothing_types
filterapply_filters( 'cmb2_all_or_nothing_types', array( 'select', 'radio', 'radio_inline', 'taxonomy_select', 'taxonomy_select_hierarchical', 'taxonomy_radio', 'taxonomy_radio_inline', 'taxonomy_radio_hierarchical', ), $this ); -
cmb2_get_metabox_form
filterapply_filters( 'cmb2_get_metabox_form', $form, $object_id, $cmb ); -
cmb2_get_metabox_form_format
filterapply_filters( 'cmb2_get_metabox_form_format', $args['form_format'], $object_id, $cmb ); -
cmb2_init_hooks
actiondo_action( 'cmb2_init_hooks', $this ); -
cmb2_localized_data
filterapply_filters( 'cmb2_localized_data', $l10n ); -
apply_filters( "cmb2_override_option_get_{$this->key}", 'cmb2_no_override_option_get', $default, $this ); -
apply_filters( "cmb2_override_option_save_{$this->key}", 'cmb2_no_override_option_save', $this->options, $this ); -
cmb2_script_dependencies
filterapply_filters( 'cmb2_script_dependencies', self::$dependencies ); -
cmb2_tab_group_tabs
filterapply_filters( 'cmb2_tab_group_tabs', $tabs, $tab_group ); -
oembed_ttl
filterapply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 ); -
plugin_locale
filterapply_filters( 'plugin_locale', function_exists( 'determine_locale' ) ? determine_locale() : get_locale(), 'cmb2' );
Generated from CMB2's GPL-licensed source code. Hooks inside bundled third-party libraries are not listed.
Can't find the right hook?
We can build the customisation for you. Describe what you need: