CMB2 icon
Forms

CMB2 hooks reference

  • By Justin Sternberg
  • v2.13.5
  • Updated

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.

functions.phpyour child theme
// 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

  • includes/rest-api/CMB2_REST.php line 970 · used in 2 places
    /**
     * 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 );
  • includes/CMB2_Base.php line 548
    /**
     * Allows overloading the object (CMB2 or CMB2_Field) with additional
     * capabilities by registering hook callbacks.
     */
    apply_filters_ref_array( "{$object_class}_inherit_{$method}", $args );
  • includes/types/CMB2_Type_Base.php line 109
    /**
     * 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 );
  • includes/types/CMB2_Type_File_Base.php line 60
    /**
     * 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 );
  • includes/CMB2.php line 901
    /**
     * Fires before fields have been processed/saved.
     */
    do_action( "cmb2_{$object_type}_process_fields_{$this->cmb_id}", $this, $this->object_id() );
  • bootstrap.php line 26
    /**
     * Fires on the admin side when CMB2 is included/loaded.
     */
    do_action( 'cmb2_admin_init' );
  • includes/CMB2_Field.php line 947
    /**
     * Hook after field row ends.
     */
    do_action( "cmb2_after_{$field_type}_field_row", $this );
  • includes/CMB2.php line 469
    /**
     * Hook after form form has been rendered
     */
    do_action( "cmb2_after_{$object_type}_form_{$this->cmb_id}", $object_id, $this );
  • includes/CMB2_Field.php line 954
    /**
     * Hook after field row ends.
     */
    do_action( 'cmb2_after_field_row', $this );
  • includes/CMB2.php line 481
    /**
     * Hook after form form has been rendered
     */
    do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this );
  • bootstrap.php line 81
    /**
     * Fires after CMB2 initiation process has been completed
     */
    do_action( 'cmb2_after_init' );
  • includes/rest-api/CMB2_REST_Controller_Boxes.php line 106
    /**
     * By default, no special permissions needed.
     */
    apply_filters( 'cmb2_api_get_boxes_permissions_check', true, $this );
  • includes/CMB2_Field.php line 909
    /**
     * Hook before field row begins.
     */
    do_action( "cmb2_before_{$field_type}_field_row", $this );
  • includes/CMB2.php line 359
    /**
     * Hook before form table begins
     */
    do_action( "cmb2_before_{$object_type}_form_{$this->cmb_id}", $object_id, $this );
  • includes/CMB2_Field.php line 900
    /**
     * Hook before field row begins.
     */
    do_action( 'cmb2_before_field_row', $this );
  • includes/CMB2.php line 344
    /**
     * Hook before form table begins
     */
    do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this );
  • cmb2_can_save

    filter
    includes/CMB2_Hookup.php line 974
    /**
     * Filter to determine if metabox is allowed to save.
     */
    apply_filters( 'cmb2_can_save', $can_save, $this->cmb );
  • includes/CMB2_Field_Display.php line 123
    /**
     * 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 );
  • includes/CMB2_Hookup.php line 1031
    /**
     * Filter to determine if CMB2'S css should be enqueued.
     */
    apply_filters( 'cmb2_enqueue_css', true );
  • includes/CMB2_Hookup.php line 1056
    /**
     * Filter to determine if CMB2'S JS should be enqueued.
     */
    apply_filters( 'cmb2_enqueue_js', true );
  • includes/CMB2_Field.php line 1428
    /**
     * Filter the CMB2 Field arguments after processing.
     */
    apply_filters( 'cmb2_field_arguments', $args, $this );
  • includes/CMB2_Field.php line 1381
    /**
     * Filtering the CMB2 Field arguments once merged with the defaults, but before
     * further processing.
     */
    apply_filters( 'cmb2_field_arguments_raw', $args, $this );
  • includes/CMB2_Field.php line 1369
    /**
     * Filter the CMB2 Field defaults.
     */
    apply_filters( 'cmb2_field_defaults', $defaults, $args['id'], $args['type'], $this );
  • includes/CMB2_Field.php line 1071
    /**
     * Filter the value before it is sent to the REST request.
     */
    apply_filters( 'cmb2_get_rest_value', $value, $this );
  • includes/CMB2_Field.php line 1083
    /**
     * Filter the value before it is sent to the REST request.
     */
    apply_filters( "cmb2_get_rest_value_{$field_type}", $value, $this );
  • includes/CMB2_Field.php line 1095
    /**
     * Filter the value before it is sent to the REST request.
     */
    apply_filters( "cmb2_get_rest_value_for_{$field_id}", $value, $this );
  • includes/CMB2.php line 632
    /**
     * Allow for adding additional HTML attributes to a group wrapper.
     */
    apply_filters( 'cmb2_group_wrap_attributes', $group_wrap_attributes, $field_group );
  • cmb2_init

    action
    bootstrap.php line 34
    /**
     * Fires when CMB2 is included/loaded
     */
    do_action( 'cmb2_init' );
  • includes/CMB2.php line 285
    /**
     * Hook during initiation of CMB2 object
     */
    do_action( "cmb2_init_{$this->cmb_id}", $this );
  • bootstrap.php line 50
    /**
     * Fires after all CMB2 instances are created
     */
    do_action( 'cmb2_init_before_hookup' );
  • bootstrap.php line 75
    /**
     * Initiates the box "hookup" into WordPress.
     */
    do_action( "cmb2_init_hookup_{$cmb->cmb_id}", $cmb );
  • includes/CMB2_Utils.php line 377
    /**
     * Filter the CMB location url.
     */
    apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION );
  • bootstrap.php line 42
    /**
     * 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() );
  • includes/CMB2_Field.php line 664
    /**
     * Filter field types that are non-repeatable.
     */
    apply_filters( 'cmb2_non_repeatable_fields', array() );
  • includes/CMB2_Field.php line 432
    /**
     * Filter whether to override removing of meta value.
     */
    apply_filters( "cmb2_override_{$a['field_id']}_meta_remove", $override, $a, $this->args(), $this );
  • includes/CMB2_Field.php line 355
    /**
     * 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 );
  • includes/CMB2_Field.php line 287
    /**
     * 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 );
  • includes/CMB2_Field.php line 410
    /**
     * 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 );
  • includes/CMB2_Field.php line 344
    /**
     * 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 );
  • includes/CMB2_Field.php line 276
    /**
     * 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 );
  • includes/CMB2_Field.php line 1142
    /**
     * A filter to bypass the default display.
     */
    apply_filters( "cmb2_pre_field_display_{$field_type}", null, $this, $display );
  • includes/CMB2_Types.php line 78
    /**
     * 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 );
  • includes/CMB2_Types.php line 275
    /**
     * 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 );
  • includes/CMB2_Field.php line 993
    /**
     * By default, 'text_url' and 'text' fields get table-like styling
     */
    apply_filters( 'cmb2_repeat_table_row_types', array( 'text_url', 'text', ) );
  • includes/rest-api/CMB2_REST_Controller.php line 407
    /**
     * 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 );
  • includes/rest-api/CMB2_REST_Controller.php line 535
    /**
     * Filter the prepared CMB2 item response.
     */
    apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
  • includes/CMB2_Sanitize.php line 175
    /**
     * Filter whether 'taxonomy_*' fields should return their value when being
     * sanitized.
     */
    apply_filters( "cmb2_return_taxonomy_values_{$cmb_id}", $return_values, $this );
  • includes/CMB2_Field.php line 1031
    /**
     * Globally filter row classes
     */
    apply_filters( 'cmb2_row_classes', implode( ' ', $classes ), $this );
  • includes/CMB2_Field.php line 506
    /**
     * Filter the value before it is saved.
     */
    apply_filters( "cmb2_sanitize_{$field_type}", null, $sanitizer->value, $this->object_id, $this->args(), $sanitizer );
  • includes/CMB2.php line 931
    /**
     * Fires after all fields have been saved.
     */
    do_action( "cmb2_save_{$object_type}_fields", $object_id, $this->cmb_id, $this->updated, $this );
  • includes/CMB2.php line 947
    /**
     * Fires after all fields have been saved.
     */
    do_action( "cmb2_save_{$object_type}_fields_{$this->cmb_id}", $object_id, $this->updated, $this );
  • includes/CMB2_Field.php line 592
    /**
     * Hooks after save field action.
     */
    do_action( 'cmb2_save_field', $field_id, $updated, $action, $this );
  • includes/CMB2_Field.php line 606
    /**
     * Hooks after save field action.
     */
    do_action( "cmb2_save_field_{$field_id}", $updated, $action, $this );
  • includes/CMB2.php line 1178
    /**
     * Filter the metabox object type.
     */
    apply_filters( 'cmb2_set_box_object_type', $mb_object_type, $found_type, $this );
  • includes/CMB2.php line 1111
    /**
     * Filter the object id.
     */
    apply_filters( 'cmb2_set_object_id', $object_id, $this );
  • includes/CMB2_Options.php line 195
    /**
     * Whether to auto-load the option when WordPress starts up.
     */
    apply_filters( "cmb2_should_autoload_{$this->key}", true, $this );
  • includes/CMB2_Hookup.php line 337
    /**
     * 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
    includes/CMB2_Hookup.php line 815
    /**
     * Filter to determine if metabox should show. Default is true.
     */
    apply_filters( 'cmb2_show_on', $show, $this->cmb->meta_box, $this->cmb );
  • includes/CMB2_Hookup.php line 218
    /**
     * 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 );
  • includes/CMB2_Hookup.php line 273
    /**
     * Filters the registered style dependencies for the cmb2 stylesheet.
     */
    apply_filters( 'cmb2_style_dependencies', array() );
  • includes/types/CMB2_Type_Taxonomy_Radio.php line 57
    /**
     * Default (option-none) taxonomy-radio value.
     */
    apply_filters( "cmb2_taxonomy_radio_{$field_id}_default_value", $option_none_value );
  • includes/types/CMB2_Type_Taxonomy_Radio.php line 46
    /**
     * Default (option-none) taxonomy-radio value.
     */
    apply_filters( 'cmb2_taxonomy_radio_default_value', '' );
  • includes/types/CMB2_Type_Taxonomy_Select.php line 74
    /**
     * Default (option-none) taxonomy-select value.
     */
    apply_filters( "cmb2_taxonomy_select_{$field_id}_default_value", $option_none_value );
  • includes/types/CMB2_Type_Taxonomy_Select.php line 63
    /**
     * Default (option-none) taxonomy-select value.
     */
    apply_filters( 'cmb2_taxonomy_select_default_value', '' );
  • includes/CMB2_Field.php line 743
    /**
     * Filter the value for escaping before it is ouput.
     */
    apply_filters( "cmb2_types_esc_{$field_type}", null, $meta_value, $this->args(), $this );
  • includes/types/CMB2_Type_File_Base.php line 45
    /**
     * Which image types are considered valid image file extensions.
     */
    apply_filters( 'cmb2_valid_img_types', $valid_types );
  • includes/CMB2.php line 421
    /**
     * Globally filter box wrap classes
     */
    apply_filters( 'cmb2_wrap_classes', $classes, $this );
  • includes/CMB2_Base.php line 456
    /**
     * Fires when a deprecated argument is called. This is a WP core action.
     */
    do_action( 'deprecated_argument_run', $function, $message, $version );
  • includes/CMB2_Base.php line 465
    /**
     * 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
    includes/shim/WP_REST_Controller.php line 537
    /**
     * Filter the post.
     */
    apply_filters( 'rest_the_post', $post_obj, $post );
  • includes/CMB2_Field.php line 1339 · used in 2 places
    apply_filters( 'cmb2_default_filter', $default, $this );
  • includes/CMB2_Sanitize.php line 72 · used in 2 places
    apply_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}" );
  • includes/CMB2_Field.php line 687
    apply_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 );
  • includes/helper-functions.php line 285
    apply_filters( 'cmb2_get_metabox_form', $form, $object_id, $cmb );
  • includes/helper-functions.php line 339
    apply_filters( 'cmb2_get_metabox_form_format', $args['form_format'], $object_id, $cmb );
  • includes/CMB2_Hookup.php line 104
    do_action( 'cmb2_init_hooks', $this );
  • includes/CMB2_JS.php line 254
    apply_filters( 'cmb2_localized_data', $l10n );
  • includes/CMB2_Options.php line 217
    apply_filters( "cmb2_override_option_get_{$this->key}", 'cmb2_no_override_option_get', $default, $this );
  • includes/CMB2_Options.php line 178
    apply_filters( "cmb2_override_option_save_{$this->key}", 'cmb2_no_override_option_save', $this->options, $this );
  • includes/CMB2_JS.php line 80
    apply_filters( 'cmb2_script_dependencies', self::$dependencies );
  • includes/CMB2_Options_Hookup.php line 278
    apply_filters( 'cmb2_tab_group_tabs', $tabs, $tab_group );
  • oembed_ttl

    filter
    includes/CMB2_Ajax.php line 392
    apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 );
  • plugin_locale

    filter
    init.php line 186
    apply_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: