$sanitizer->checkbox() method

Sanitize checkbox value

Available since version 3.0.128.


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

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


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.236

Latest news

  • ProcessWire Weekly #518
    The 518th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 13 April 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

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