---
name: "HTML::FormHandler::Field::Checkbox"
section: "3pm"
platform: "linux"
package: "libhtml-formhandler-perl"
version: "0.40068-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/HTML::FormHandler::Field::Checkbox"
---

# HTML::FormHandler::Field::Checkbox(3pm)

a checkbox field type

## NAME

HTML::FormHandler::Field::Checkbox - a checkbox field type

## VERSION

version 0.40068

## DESCRIPTION

This field is very similar to the Boolean Widget except that this field allows other positive values besides 1. Since unselected checkboxes do not return a parameter, fields with Checkbox type will always be set to the 'input\_without\_param' default if they do not appear in the form.

### widget

checkbox

### checkbox\_value

In order to create the HTML for a checkbox, there must be a 'value="xx"'. This value is specified with the 'checkbox\_value' attribute, which defaults to 1.

### input\_without\_param

If the checkbox is not checked, it will be set to the value of this attribute (the unchecked value). Default = 0. Because unchecked checkboxes do not return anything in the HTTP parameters, the absence of a checkbox key in the parameters hash forces this field to this value. This means that Checkbox fields, unlike other fields, will not be ignored if there is no input. If a particular checkbox should not be processed for a particular form, you must set 'inactive' to 1 instead.

Note that a checkbox is only 'checked' when the 'checkbox\_value' is provided. The 'value' for a non-checked checkbox is only really useful for creating form values such as are stored in a database.

## AUTHOR

FormHandler Contributors - see HTML::FormHandler

## COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Gerda Shank.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.