$sanitizer->checkbox() method

Sanitize checkbox value

Available since version 3.0.128.

Usage

// basic usage
$int = $sanitizer->checkbox($value);

// usage with all arguments
$int = $sanitizer->checkbox($value, $yes = true, $no = false);

Arguments

NameType(s)Description
valueint, bool, string, mixed, null

Value to check

yes (optional)int, bool, string, mixed, null

Value to return if checked (default=true)

no (optional)int, bool, string, mixed, null

Value to return if not checked (default=false)

Return value

int bool string mixed null

Return value, based on $checked or $unchecked argument

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

  • ProcessWire Weekly #582
    The 582nd issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 5 July 2025
  • New ProcessWire admin redesign
    When you upgrade to ProcessWire 3.0.248 or newer (currently the dev branch), you’ll immediately notice something new and beautiful…
    Blog / 9 May 2025
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer