Skip to content

Cannot make city field optional in addresses #38325

Open
@ioweb-gr

Description

@ioweb-gr

Summary

In our country we have regions but we don't use cities for delivery nor postcodes as we're a small country.

However making the address attributes optional doesn't actually make them optional in the checkout.

The problem lies in \Magento\Customer\Model\Address\Validator\General::checkRequredFields

/**
     * Check fields that are generally required.
     *
     * @param AbstractAddress $address
     * @return array
     * @throws \Zend_Validate_Exception
     */
    private function checkRequredFields(AbstractAddress $address)
    {
        $errors = [];
        if (!\Zend_Validate::is($address->getFirstname(), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'firstname']);
        }

        if (!\Zend_Validate::is($address->getLastname(), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'lastname']);
        }

        if (!\Zend_Validate::is($address->getStreetLine(1), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'street']);
        }

        if (!\Zend_Validate::is($address->getCity(), 'NotEmpty')) {
            $errors[] = __('"%fieldName" is required. Enter and try again.', ['fieldName' => 'city']);
        }

        return $errors;
    }

As you can see in the code the city field is hardcoded in the rule validations but it's not actively checking the attribute whether it's required or not.

So the only way for a user to work around this is to create a plugin and set the billing city to some random string like a dash or a dot

In my opinion this should check the attribute's required column status

Examples

You just need to try and checkout without filling in the city after you change the required attribute value

+---------------+------+
|attribute_id   |29    |
+---------------+------+
|entity_type_id |2     |
+---------------+------+
|attribute_code |city  |
+---------------+------+
|attribute_model|null  |
+---------------+------+
|backend_model  |null  |
+---------------+------+
|backend_type   |static|
+---------------+------+
|backend_table  |null  |
+---------------+------+
|frontend_model |null  |
+---------------+------+
|frontend_input |text  |
+---------------+------+
|frontend_label |City  |
+---------------+------+
|frontend_class |null  |
+---------------+------+
|source_model   |null  |
+---------------+------+
|is_required    |0     |
+---------------+------+
|is_user_defined|0     |
+---------------+------+
|default_value  |null  |
+---------------+------+
|is_unique      |0     |
+---------------+------+
|note           |null  |
+---------------+------+

Proposed solution

Check the attribute before validating instead of hardcoding the requirement

Release note

No response

Triage and priority

  • Severity: S0 - Affects critical data or functionality and leaves users without workaround.
  • Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
  • Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
  • Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
  • Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

Metadata

Metadata

Assignees

Labels

Area: Cart & CheckoutComponent: CustomerAttributesIssue: ConfirmedGate 3 Passed. Manual verification of the issue completed. Issue is confirmedPriority: P3May be fixed according to the position in the backlog.Progress: PR in progressReported on 2.4.xIndicates original Magento version for the Issue report.Reproduced on 2.4.xThe issue has been reproduced on latest 2.4-develop branchTriage: Dev.ExperienceIssue related to Developer Experience and needs help with Triage to Confirm or Reject it

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions