Skip to content

40564: Added support for 'disabled' state for individual select options#40565

Open
rybkinevg wants to merge 20 commits intomagento:2.4-developfrom
rybkinevg:40564-support-disabled-state-for-individual-select-options
Open

40564: Added support for 'disabled' state for individual select options#40565
rybkinevg wants to merge 20 commits intomagento:2.4-developfrom
rybkinevg:40564-support-disabled-state-for-individual-select-options

Conversation

@rybkinevg
Copy link
Copy Markdown
Contributor

@rybkinevg rybkinevg commented Mar 2, 2026

Description (*)

Added support for the disabled property on individual <option> elements within select form fields.

If the disabled key is set to true in the option array it renders the disabled="disabled" attribute accordingly.

Fixed Issues (if relevant)

  1. Fixes [Feature] Support "disabled" state for individual select options in the admin config #40564

Manual testing scenarios (*)

Select & Multiselect elements

1) Modify the builtin source model:

Open the file app/code/Magento/Directory/Model/Config/Source/Country.php and modify the toOptionArray() method to randomly disable some options:

public function toOptionArray($isMultiselect = false, $foregroundCountries = '')
{
    // ...

    foreach ($options as &$option) {
        $option['disabled'] = rand(0, 1);
    }

    return $options;
}

2) Clear cache

3) Navigate to admin configuration area

Go to Stores -> Configuration -> General -> General, expand the Country Options section

4) Verify the "Default Country" field (select)

Uncheck the "Use system value" and click on the dropdown to expand the options, some options should be disabled

SCR-20260309-prcu

5) Verify the "Allow Countries" field (multiselect)

Uncheck the "Use system value" and click on the dropdown to expand the options, some options should be disabled

SCR-20260309-prqc

Editablemultiselect element

1) Modify the builtin source model:

Open the file app/code/Magento/Tax/Model/Rate/Source.php and modify the toOptionArray() method to randomly disable some options:

public function toOptionArray()
{
    // ...

    foreach ($this->options as &$option) {
        $option['disabled'] = rand(0, 1);
    }

    return $this->options;
}

2) Clear cache

3) Navigate to tax rule management

Go to Stores -> Tax Rules, click "Add New Tax Rule"

4) Verify the "Tax Rate" field (editablemultiselect)

Some options should be disabled

SCR-20260309-puoc

Questions or comments

Current implementation treats all truthy values of the disabled property as the disabled state:

if ($option['disabled'] ?? false) {
    $html .= ' disabled="disabled"';
}

I am not sure, is this correct, or should we treat only explicitly true values as disabled state? For example:

if (isset($option['disabled']) && $option['disabled'] === true) {
    $html .= ' disabled="disabled"';
}

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link
Copy Markdown

m2-assistant bot commented Mar 2, 2026

Hi @rybkinevg. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@rybkinevg
Copy link
Copy Markdown
Contributor Author

@magento run all tests

@rybkinevg
Copy link
Copy Markdown
Contributor Author

@magento run Static Tests

@rybkinevg
Copy link
Copy Markdown
Contributor Author

@magento run all tests

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds framework-level support for disabling individual <option> entries in Magento\Framework\Data\Form\Element\Select, enabling source models to mark specific options as non-selectable (e.g., via ['disabled' => true]).

Changes:

  • Render disabled="disabled" on <option> when the option array contains a truthy disabled flag.
  • Add unit coverage validating disabled option rendering for both plain options and options within an <optgroup>.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
lib/internal/Magento/Framework/Data/Form/Element/Select.php Adds disabled="disabled" attribute rendering for per-option disabled state.
lib/internal/Magento/Framework/Data/Test/Unit/Form/Element/SelectTest.php New unit tests covering disabled option rendering (including optgroups) across various disabled values.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@ihor-sviziev
Copy link
Copy Markdown
Contributor

@magento run all tests

Copy link
Copy Markdown
Contributor

@ihor-sviziev ihor-sviziev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Functional test failures look as a false positives, so approving

@rybkinevg
Copy link
Copy Markdown
Contributor Author

@ihor-sviziev, since PR is approved, what are the next steps? is there anything else required of me?

@ihor-sviziev
Copy link
Copy Markdown
Contributor

@rybkinevg, no, the PR will be voted and if it gets enough likes by community 👍 - it will be chosen for delivery

@rybkinevg
Copy link
Copy Markdown
Contributor Author

@ihor-sviziev , I've added support for the disabled option state in the Multiselect and Editablemultiselect elements.

Should I also cover the disabled option state in the MultiselectTest and EditablemultiselectTest tests? I'm a bit unsure, because it seems that the logic would essentially be copied from SelectTest. Is that acceptable in this case?

I also noticed that MultiselectTest actually uses Editablemultiselect instead of the Multiselect class in the $_model property (source):

$this->_model = $testHelper->getObject(
    Editablemultiselect::class, // <-- here
    [
        '_escaper' => $escaper,
        'random' => $randomMock,
        'secureRenderer' => $secureRendererMock
    ]
);

Should this be corrected as well?

@ihor-sviziev ihor-sviziev moved this from Ready for Testing to Review in Progress in Pull Requests Dashboard Mar 9, 2026
@ihor-sviziev
Copy link
Copy Markdown
Contributor

@rybkinevg I think the best approach is to cover this case for each component individually, since they all follow the same logic. Could you please update it accordingly?

@ihor-sviziev ihor-sviziev moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Mar 9, 2026
@rybkinevg
Copy link
Copy Markdown
Contributor Author

rybkinevg commented Mar 9, 2026

@ihor-sviziev , I've added test cases for disabled option state in the MultiselectTest and EditablemultiselectTest tests, could you please review updates?

@ihor-sviziev ihor-sviziev moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Mar 11, 2026
@ihor-sviziev
Copy link
Copy Markdown
Contributor

@magentoe run all tests

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

@rybkinevg
Copy link
Copy Markdown
Contributor Author

@magento run all tests

@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Review in Progress to Ready for Testing in Pull Requests Dashboard Mar 13, 2026
@engcom-Bravo engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Mar 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: P3 May be fixed according to the position in the backlog. Progress: ready for testing Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Projects

Status: Ready for Testing

Development

Successfully merging this pull request may close these issues.

[Feature] Support "disabled" state for individual select options in the admin config

5 participants