Skip to content
  • Documentation >
  • API >
  • Field Type >
  • Field Types reference >
  • Checkbox Field Type

Checkbox Field Type

The Checkbox Field Type stores the current status for a checkbox input, checked or unchecked, by storing a boolean value.

Name Internal name Expected input type
Checkbox ezboolean boolean

PHP API Field Type

Value object

Properties

The Value class of this Field Type contains the following properties:

Property Type Default value Description
$bool boolean false This property is used for the checkbox status, represented by a boolean value. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
//Value object content examples
use eZ\Publish\Core\FieldType\Checkbox\Type;
 
// Instantiates a checkbox value with a default state (false)
$checkboxValue = new Checkbox\Value();
 
// Checked
$value->bool = true;

// Unchecked
$value->bool = false;
Constructor

The Checkbox\Value constructor accepts a boolean value:

1
2
3
4
5
// Constructor example
use eZ\Publish\Core\FieldType\Checkbox\Type;
 
// Instantiates a checkbox value with a checked state
$checkboxValue = new Checkbox\Value( true );
String representation

As this Field Type is not a string but a boolean, it will return "1" (true) or "0" (false) in cases where it is cast to string.