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

Class CMB2_Hookup_Base

Base class for hooking CMB2 into WordPress.

Direct known subclasses

CMB2_Hookup, CMB2_REST

Indirect known subclasses

CMB2_Options_Hookup, Test_CMB2_REST_Object

Abstract
Package: CMB2
Category: WordPress_Plugin
License: GPL-2.0+
Author: CMB2 team
Since: 2.2.0
Link: https://cmb2.io
Located at includes/CMB2_Hookup_Base.php

Methods summary

public static
# maybe_init_and_hookup( CMB2 $cmb )

A functionalized constructor, used for the hookup action callbacks.

A functionalized constructor, used for the hookup action callbacks.

Parameters

$cmb
The CMB2 object to hookup.

Throws

Exception
Failed implementation.

Since

2.2.6
public
# __construct( CMB2 $cmb )

Constructor

Constructor

Parameters

$cmb
The CMB2 object to hookup.

Since

2.0.0
abstract public
# universal_hooks( )
public
# once( string $action, callable $hook, integer $priority = 10, integer $accepted_args = 1 )

Ensures WordPress hook only gets fired once per object.

Ensures WordPress hook only gets fired once per object.

Parameters

$action
The name of the filter to hook the $hook callback to.
$hook
The callback to be run when the filter is applied.
$priority
Order the functions are executed.
$accepted_args
The number of arguments the function accepts.

Since

2.0.0
public mixed
# __get( string $field )

Magic getter for our object.

Magic getter for our object.

Parameters

$field
Property to return.

Returns

mixed

Throws

Exception
Throws an exception if the field is invalid.

Properties summary

protected CMB2 $cmb

CMB2 object.

CMB2 object.

Since

2.0.2
#
protected string $object_type

The object type we are performing the hookup for

The object type we are performing the hookup for

Since

2.0.9
# 'post'

Magic properties

public read-only string $object_type
public read-only CMB2 $cmb
CMB2 Documentation API documentation generated by ApiGen