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_Boxes

A CMB2 object instance registry for storing every CMB2 instance.

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

Methods summary

public static
# add( CMB2 $cmb_instance )

Add a CMB2 instance object to the registry.

Add a CMB2 instance object to the registry.

Parameters

$cmb_instance
CMB2 instance.

Since

1.X.X
public static
# remove( string $cmb_id )

Remove a CMB2 instance object from the registry.

Remove a CMB2 instance object from the registry.

Parameters

$cmb_id
A CMB2 instance id.

Since

1.X.X
public static CMB2|boolean
# get( string $cmb_id )

Retrieve a CMB2 instance by cmb id.

Retrieve a CMB2 instance by cmb id.

Parameters

$cmb_id
A CMB2 instance id.

Returns

CMB2|boolean
False or CMB2 object instance.

Since

1.X.X
public static CMB2[]
# get_all( )

Retrieve all CMB2 instances registered.

Retrieve all CMB2 instances registered.

Returns

CMB2[]
Array of all registered cmb2 instances.

Since

1.X.X
public static CMB2[]
# get_by( string $property, mixed $compare = 'nocompare' )

Retrieve all CMB2 instances that have the specified property set.

Retrieve all CMB2 instances that have the specified property set.

Parameters

$property
Property name.
$compare
(Optional) The value to compare.

Returns

CMB2[]
Array of matching cmb2 instances.

Since

2.4.0
public static CMB2[]
# filter_by( string $property, mixed $to_ignore = null )

Retrieve all CMB2 instances as long as they do not include the ignored property.

Retrieve all CMB2 instances as long as they do not include the ignored property.

Parameters

$property
Property name.
$to_ignore
The value to ignore.

Returns

CMB2[]
Array of matching cmb2 instances.

Since

2.4.0
public static CMB2[]
# get_by_property( string $property, mixed $to_ignore = null )

Deprecated and left for back-compatibility. The original get_by_property method was misnamed and never actually used by CMB2 core.

Deprecated and left for back-compatibility. The original get_by_property method was misnamed and never actually used by CMB2 core.

Parameters

$property
Property name.
$to_ignore
The value to ignore.

Returns

CMB2[]
Array of matching cmb2 instances.

Since

2.2.3

Properties summary

protected static array $cmb2_instances

Array of all metabox objects.

Array of all metabox objects.

Since

2.0.0
# array()
CMB2 Documentation API documentation generated by ApiGen