$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.214

Twitter updates

  • This week ProcessWire 3.0.214 is on the dev branch. Relative to 3.0.213 this version has 16 new commits which include the addition of 3 new pull requests, 6 issue fixes, a new WireNumberTools utility class, and various other improvements. More
    17 March 2023
  • ProcessWire 3.0.213 core updates: This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields. More
    24 February 2023
  • ProcessWire 3.0.212 core updates— More
    17 February 2023

Latest news

  • ProcessWire Weekly #462
    In the 462nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a new third party module called Template Access Log, and more. Read on!
    Weekly.pw / 18 March 2023
  • ProcessWire 3.0.213 core updates
    This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields.
    Blog / 24 February 2023
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer