CommonsBooking 2.11.3 has 38 actions and 91 filters, read directly from its source code on Nov 18, 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 CommonsBooking fires an action
add_action( 'cmb2_init', function() {
// Your code runs here.
}, 10, 1 );
// Change a value CommonsBooking 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
-
/** * Fires when CMB2 is included/loaded */ do_action( 'cmb2_init' ); -
cmb2_rest_enforce_options_page_read_permissions
filter Used by 7 plugins → Copy link Customise this hook/** * 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 ); -
/** * Default list of booking rules that get applied before booking confirmation */ apply_filters( "{COMMONSBOOKING_PLUGIN_SLUG}_booking-rules", $defaultRuleSet ); -
/** * 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() ); -
/** * 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 ); -
/** * Hook after field row ends. */ do_action( 'cmb2_after_field_row', $this ); -
/** * Hook after form form has been rendered */ do_action( 'cmb2_after_form', $this->cmb_id, $object_id, $object_type, $this ); -
/** * 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 ); -
/** * Hook before field row begins. */ do_action( 'cmb2_before_field_row', $this ); -
/** * Hook before form table begins */ do_action( 'cmb2_before_form', $this->cmb_id, $object_id, $object_type, $this ); -
/** * 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 ); -
/** * Filter to determine if CMB2'S css should be enqueued. */ apply_filters( 'cmb2_enqueue_css', true ); -
/** * Filter to determine if CMB2'S JS should be enqueued. */ apply_filters( 'cmb2_enqueue_js', true ); -
/** * Filter the CMB2 Field arguments after processing. */ apply_filters( 'cmb2_field_arguments', $args, $this ); -
/** * Filtering the CMB2 Field arguments once merged with the defaults, but before * further processing. */ apply_filters( 'cmb2_field_arguments_raw', $args, $this ); -
/** * Filter the CMB2 Field defaults. */ apply_filters( 'cmb2_field_defaults', $defaults, $args['id'], $args['type'], $this ); -
/** * 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 ); -
/** * Allow for adding additional HTML attributes to a group wrapper. */ apply_filters( 'cmb2_group_wrap_attributes', $group_wrap_attributes, $field_group ); -
/** * Hook during initiation of CMB2 object */ do_action( "cmb2_init_{$this->cmb_id}", $this ); -
/** * 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 ); -
/** * Filter the CMB location url. */ apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION ); -
/** * 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() ); -
/** * 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 ); -
/** * 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 ); -
/** * 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 ); -
/** * 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 ); -
/** * 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 ); -
/** * 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 ); -
/** * 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 ); -
/** * Globally filter row classes */ apply_filters( 'cmb2_row_classes', implode( ' ', $classes ), $this ); -
/** * 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 ); -
/** * Hooks after save field action. */ do_action( 'cmb2_save_field', $field_id, $updated, $action, $this ); -
/** * Hooks after save field action. */ do_action( "cmb2_save_field_{$field_id}", $updated, $action, $this ); -
/** * Filter the metabox object type. */ apply_filters( 'cmb2_set_box_object_type', $mb_object_type, $found_type, $this ); -
/** * 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 ); -
/** * Filter to determine if CMB2 should be pre-enqueued on the current page. */ apply_filters( 'cmb2_should_pre_enqueue', $should_pre_enqueue, $hook, $this ); -
/** * 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 ); -
/** * 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', '' ); -
/** * Filter the value for escaping before it is ouput. */ apply_filters( "cmb2_types_esc_{$field_type}", null, $meta_value, $this->args(), $this ); -
/** * Which image types are considered valid image file extensions. */ apply_filters( 'cmb2_valid_img_types', $valid_types ); -
/** * Globally filter box wrap classes */ apply_filters( 'cmb2_wrap_classes', $classes, $this ); -
/** * Default list of admin roles */ apply_filters( 'commonsbooking_admin_roles', $adminRoles ); -
/** * Default location booking reminder message */ apply_filters( 'commonsbooking_before_send_location_reminder_mail', $sendMessageToBeFiltered ); -
/** * Default assoc array of row data and the booking object, which gets added to * the booking list data result. */ apply_filters( 'commonsbooking_booking_filter', $rowData, $booking ); -
/** * Default list of cmb2 meta boxes definitions. */ apply_filters( 'commonsbooking_custom_metadata', $metaDataFields ); -
/** * Default value (from option settings) whether adding the ical attachment to * booking codes email. */ apply_filters( 'commonsbooking_emailcodes_addical', $cbSettingsOption, $timeframe ); -
/** * Default description of booking codes ical event */ apply_filters( 'commonsbooking_emailcodes_icalevent_desc', $unfilteredDesc, $bookingCode ); -
/** * Default title of booking codes ical event */ apply_filters( 'commonsbooking_emailcodes_icalevent_title', $unfilteredTitle, $bookingCode ); -
/** * Default rendering of the booking code table in the specified target. */ apply_filters( 'commonsbooking_emailcodes_rendertable', $renderedTable, $bookingCodes, $renderTarget ); -
/** * The names of the feeds that are available in the GBFS route. They will be * announced through the gbfs.json. The routes still need to be registered * using register_rest_route. */ apply_filters( 'commonsbooking_gbfs_feeds', [ 'system_information', 'station_information', 'station_status', 'vehicle_availability', 'vehicle_status', 'vehicle_types', ] ); -
/** * Allow 3rd party plugin filter template file from their plugin */ apply_filters( 'commonsbooking_get_template_part', $template, $slug, $name, $plugin_slug ); -
/** * Default value if current user is cb manager. */ apply_filters( 'commonsbooking_isCurrentUserCBManager', $isManager, $user ); -
/** * Default value if current user is subscriber. */ apply_filters( 'commonsbooking_isCurrentUserSubscriber', $isSubscriber, $user ); -
/** * Default value if user is admin. */ apply_filters( 'commonsbooking_isUserAdmin', $isAdmin, $user ); -
/** * E-Mail attachment */ apply_filters( 'commonsbooking_mail_attachment', $attachment, $messageAction ); -
/** * E-Mail message body */ apply_filters( 'commonsbooking_mail_body', $body, $messageAction ); -
/** * E-Mail message subject */ apply_filters( 'commonsbooking_mail_subject', $subject, $messageAction ); -
/** * E-Mail message recipient */ apply_filters( 'commonsbooking_mail_to', $recipient, $messageAction ); -
/** * Default list of manager roles */ apply_filters( 'commonsbooking_manager_roles', $managerRoles ); -
/** * Default amount of months shown in the Litepicker mobile view portrait mode. */ apply_filters( 'commonsbooking_mobile_calendar_month_count', $month ); -
/** * Default list of privilege roles */ apply_filters( 'commonsbooking_privileged_roles', $privilegedRolesDefaults ); -
/** * Default value for post type properties. */ apply_filters( "commonsbooking_tag_{$key}_{$property}", $result, $wpObject, $args ); -
/** * Default template content */ apply_filters( 'commonsbooking_template_tag', $template ); -
/** * Default widget title */ apply_filters( 'commonsbooking_widget_title', $unfilteredTitle ); -
/** * 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 ); -
/** * Filter the post. */ apply_filters( 'rest_the_post', $post_obj, $post ); -
apply_filters( 'cmb2_default_filter', $default, $this ); -
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}" ); -
do_action( 'commonsbooking_mail_sent', $this->getAction(), new \WP_Error( 'e-mail', $msg ) ); -
apply_filters( "cmb_{$field_id}_ajax_search_result_link", $link, $object_id, $object_type ); -
apply_filters( "cmb_{$field_id}_ajax_search_result_text", $text, $object_id, $object_type ); -
cmb_field_ajax_search_autocomplete_options
filter Used by 3 plugins → Copy link Customise this hookapply_filters( 'cmb_field_ajax_search_autocomplete_options', array() ); -
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 ); -
apply_filters( 'cmb2_field_ajax_search_url', get_template_directory_uri() . '/vendor/ed-itsolutions/cmb2-field-ajax-search/' ); -
apply_filters( 'cmb2_get_metabox_form', $form, $object_id, $cmb ); -
apply_filters( 'cmb2_get_metabox_form_format', $args['form_format'], $object_id, $cmb ); -
do_action( 'cmb2_init_hooks', $this ); -
apply_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 ); -
apply_filters( 'cmb2_script_dependencies', self::$dependencies ); -
apply_filters( 'cmb2_tab_group_tabs', $tabs, $tab_group ); -
do_action( 'commonsbooking_after_booking-single', $booking->ID, $booking ); -
do_action( 'commonsbooking_after_item-calendar-header', $item->ID, $item ); -
do_action( 'commonsbooking_after_item-single', $templateData['item']->ID, $templateData['item'] ); -
do_action( 'commonsbooking_after_location-calendar-header', $location->ID, $location ); -
do_action( 'commonsbooking_after_location-single', $templateData['location']->ID, $templateData['location'] ); -
do_action( 'commonsbooking_after_timeframe-calendar' ); -
do_action( 'commonsbooking_before_booking-single', $booking->ID, $booking ); -
do_action( 'commonsbooking_before_item-calendar-header', $item->ID, $item ); -
do_action( 'commonsbooking_before_item-single', $templateData['item']->ID, $templateData['item'] ); -
do_action( 'commonsbooking_before_location-calendar-header', $location->ID, $location ); -
do_action( 'commonsbooking_before_location-single', $templateData['location']->ID, $templateData['location'] ); -
do_action( 'commonsbooking_before_timeframe-calendar' ); -
apply_filters( 'commonsbooking_disableCache', $isDisabled ); -
apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 ); -
apply_filters( 'plugin_locale', function_exists( 'determine_locale' ) ? determine_locale() : get_locale(), 'cmb2' ); -
apply_filters( 'pw_cmb2_field_select2_asset_path', plugins_url( '', __FILE__ ) ); -
do_action( 'wpml_reset_language_after_mailing' ); -
do_action( 'wpml_switch_language_for_email', $recipientUser->getEmail() );
Generated from CommonsBooking's GPL-licensed source code. Hooks inside bundled third-party libraries are not listed.
Done for you
Rather have it built for you?
Tell us what should change and we’ll write and test the code using these hooks.
Custom hook snippet
from $49
A small, update-safe change built on the plugin’s own hooks.
- Code written against the plugin’s actions and filters
- Tested on a staging copy of your site
- Install instructions included
Typical turnaround: 2–3 business days
Choose thisPlugin customisation
from $149
New features or changed behaviour, without editing the plugin’s files.
- Built as a companion plugin, so updates never wipe it
- Exact quote before we start
- Tested on staging, then deployed
Typical turnaround: 3–7 business days
Choose thisNot sure which fits? Describe what you need and we’ll suggest the simplest option.
Can't find the right hook?
We can build the customisation for you. Describe what you need: