FieldtypeCheckbox class

This Fieldtype stores an ON/OFF toggle via a single checkbox. The ON value is 1 and OFF value is 0.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the FieldtypeCheckbox class also inherits all the methods and properties of: Fieldtype, WireData and Wire.

Show class?             Show args?        

Common

NameReturnSummary 
FieldtypeCheckbox::getBlankValue(Page $page, Field $field)
intGet blank value for field 
FieldtypeCheckbox::getCompatibleFieldtypes(Field $field)
Fieldtypes nullGet an array of Fieldtypes that are compatible with this one
FieldtypeCheckbox::getDatabaseSchema(Field $field)
arrayGet database schema for field 
FieldtypeCheckbox::getInputfield(Page $page, Field $field)
InputfieldCheckboxGet Inputfield for field 
FieldtypeCheckbox::getMatchQuery($query, string $table, string $subfield, string $operator, mixed $value)
DatabaseQuery DatabaseQuerySelectGet match query for PageFinder 
FieldtypeCheckbox::getSelectorInfo(Field $field)
arrayReturn array with information about what properties and operators can be used with this field
FieldtypeCheckbox::markupValue(Page $page, Field $field)
stringGet markup value for field
FieldtypeCheckbox::sanitizeValue(Page $page, Field $field, mixed $value)
intSanitize value for field 

Additional methods and properties

In addition to the methods and properties above, FieldtypeCheckbox also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #547
    In the 547th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a couple of new modules, and more. Read on!
    Weekly.pw / 2 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer