awsmug\Torro_Forms\DB_Objects\Elements\Element_Types\Base

Checkbox::validate_field( mixed $value, awsmug\Torro_Forms\DB_Objects\Elements\Element $element, awsmug\Torro_Forms\DB_Objects\Submissions\Submission $submission )

Validates a field value for an element.

Description

See also

Checkbox

Parameters

$value: (mixed) (Required) The value to validate. It is already unslashed when it arrives here.
$element: (awsmug\Torro_Forms\DB_Objects\Elements\Element) (Required) Element to validate the field value for.
$submission: (awsmug\Torro_Forms\DB_Objects\Submissions\Submission) (Required) Submission the value belongs to.

Return

(mixed|WP_Error) Validated value, or error object on failure.

Source

File: src/db-objects/elements/element-types/base/checkbox.php

	public function validate_field( $value, $element, $submission ) {
		$settings = $this->get_settings( $element );

		$value = (bool) $value;

		if ( ! empty( $settings['required'] ) && 'no' !== $settings['required'] && ! $value ) {
			return $this->create_error( 'value_required', __( 'You must check this box.', 'torro-forms' ), $value );
		}

		return $value;
	}

Changelog

Changelog
Version	Description
1.0.0	Introduced.