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

Latest news

  • ProcessWire Weekly #551
    In the 551st issue of ProcessWire Weekly we'll check out what's new in the core this week, share a new weekly poll, and more. Read on!
    Weekly.pw / 1 December 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

“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