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_Type_Base

CMB base field type

Direct known subclasses

CMB2_Type_Counter_Base, CMB2_Type_Multi_Base, CMB2_Type_Text_Datetime_Timestamp_Timezone, CMB2_Type_Title

Indirect known subclasses

CMB2_Type_Checkbox, CMB2_Type_Colorpicker, 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_File, CMB2_Type_Text_Datetime_Timestamp, CMB2_Type_Text_Time, CMB2_Type_Textarea, CMB2_Type_Textarea_Code, CMB2_Type_Wysiwyg, CMB2_Type_File_Base, CMB2_Type_File_List, CMB2_Type_Multicheck, CMB2_Type_Oembed, CMB2_Type_Picker_Base, CMB2_Type_Radio, CMB2_Type_Select

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

Methods summary

public
# __construct( CMB2_Types $types, array $args = array() )

Constructor

Constructor

Parameters

$types
Object for the field type.
$args
Array of arguments for the type.

Since

2.2.2
abstract public string
# render( )

Handles rendering this field type.

Handles rendering this field type.

Returns

string
Rendered field type.

Since

2.2.2
public string|CMB2_Type_Base
# rendered( string|CMB2_Type_Base $rendered )

Stores the rendered field output.

Stores the rendered field output.

Parameters

$rendered
Rendered output.

Returns

string|CMB2_Type_Base
Rendered output or this object.

Since

2.2.2
public string
# get_rendered( )

Returns the stored rendered field output.

Returns the stored rendered field output.

Returns

string
Stored rendered output (if 'rendered' argument is set to false).

Since

2.2.2
public array
# parse_args( string $element, array $type_defaults, array $type_overrides = array() )

Handles parsing and filtering attributes while preserving any passed in via field config.

Handles parsing and filtering attributes while preserving any passed in via field config.

Parameters

$element
Element for filter.
$type_defaults
Type default arguments.
$type_overrides
Type override arguments.

Returns

array
Parsed and filtered arguments.

Since

1.1.0
protected array
# parse_args_from_overrides( array $type_overrides = array() )

Handles parsing and filtering attributes while preserving any passed in via field config.

Handles parsing and filtering attributes while preserving any passed in via field config.

Parameters

$type_overrides
Type override arguments.

Returns

array
Parsed arguments

Since

2.2.4
public mixed
# __call( string $method, array $arguments )

Fall back to CMB2_Types methods

Fall back to CMB2_Types methods

Parameters

$method
Method name being invoked.
$arguments
Arguments passed for the method.

Returns

mixed

Throws

Exception
Throws an exception if the field is invalid.
public mixed
# __get( string $field )

Magic getter for our object.

Magic getter for our object.

Parameters

$field
Property being requested.

Returns

mixed

Throws

Exception
Throws an exception if the field is invalid.

Properties summary

public CMB2_Types $types

The CMB2_Types object

The CMB2_Types object

#
public array $args

Arguments for use in the render method

Arguments for use in the render method

#
protected string $rendered

Rendered output (if 'rendered' argument is set to false)

Rendered output (if 'rendered' argument is set to false)

# ''
CMB2 Documentation API documentation generated by ApiGen