Automattic\WooCommerce\Blocks\Domain\Services

CheckoutFields::is_required_field │ public │ WC 1.0

Returns true if the field is required. Takes rules into consideration if a document object is provided.

Method of the class: CheckoutFields{}

No Hooks.

Returns

true|false.

Usage

$CheckoutFields = new CheckoutFields();
$CheckoutFields->is_required_field( $field, $document_object );

$field(array|string) (required)

The field array or field key.

$document_object(DocumentObject|null)

The document object.
Default: null

CheckoutFields::is_required_field() CheckoutFields::is required field code ^{WC 10.8.1}

public function is_required_field( $field, $document_object = null ) {
	if ( is_string( $field ) ) {
		$field = $this->additional_fields[ $field ] ?? [];
	}

	if ( empty( $field ) ) {
		return false;
	}

	if ( $document_object ) {
		// Hidden fields cannot be required.
		if ( $this->is_hidden_field( $field, $document_object ) ) {
			return false;
		}
		if ( $this->contains_valid_rules( $field['required'] ) ) {
			return true === Validation::validate_document_object( $document_object, $field['required'] );
		}
	}
	return true === $field['required'];
}