Enhance `label()` method in `ActiveField` with `tag` option and fix `labelOptions` for `checkbox`/`radio` (#20537). #20546

terabytesoftw · 2025-09-27T18:57:39Z

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌

Previous Behavior:

label() generates a standard <label> tag with the model attribute label.

$field->label();
// output: <label class="control-label" for="model-attribute">Attribute Name</label>

label('Custom Text') generates a <label> tag with custom text.

$field->label('My Label');
// output: <label class="control-label" for="model-attribute">My Label</label>

label(false) removes the label entirely from the field (empty string).

$field->label(false);
// output: '' (empty string, no label rendered)

label($text, $options) generates a label with custom options merged with labelOptions.

$field->label('My Label', ['class' => 'custom-class']);
// output: <label class="custom-class" for="model-attribute">My Label</label>

New Behavior:

tag => 'label' default uses Html::activeLabel() to generate a standard <label> element with the for attribute.

$field->label(options: ['label' => 'My Label']);
// output: <label class="control-label" for="model-attribute">My Label</label>

tag => false renders the label content as raw HTML without any wrapper tag.

$field->label(
    options: [
        'label' => 'My Label',
        'tag' => false,
    ],
);
// output: My Label

tag => span/div/h3/etc - uses Html::tag() to generate the specified element.

$field->label(
    'Form Section',
    [
        'class' => 'section-title',
        'tag' => 'h3',
    ],
);
// output: <h3 class="section-title">Form Section</h3>

… with `enclosedByLabel = false` in `checkbox`/`radio` methods (yiisoft#20537).

codecov · 2025-09-27T18:59:21Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.50%. Comparing base (d245fc2) to head (845442c).
⚠️ Report is 1 commits behind head on 22.0.

Additional details and impacted files

@@             Coverage Diff              @@
##               22.0   #20546      +/-   ##
============================================
- Coverage     65.61%   64.50%   -1.11%     
- Complexity    11263    11267       +4     
============================================
  Files           428      428              
  Lines         37068    37083      +15     
============================================
- Hits          24323    23922     -401     
- Misses        12745    13161     +416

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

xicond · 2025-09-27T19:05:03Z

maybe can reduce redundant code ? so it's more easy to maintain later

terabytesoftw · 2025-09-27T19:06:51Z

maybe can reduce redundant code ? so it's more easy to maintain later

Yes it is a good idea.

… inputs.

xicond · 2025-09-28T11:52:19Z

I'm thinking,
if this way can support custom tag
why dont make it consistent for

$field->checkbox( )->label('Custom Label', 'labelOptions' => [
    'class' => 'radio-option-label',
    'data-value' => 'choice-1',
    'tag' => 'span',
]);

terabytesoftw · 2025-09-28T11:57:42Z

I'm thinking, if this way can support custom tag why dont make it consistent for
$field->checkbox( )->label('Custom Label', 'labelOptions' => [
    'class' => 'radio-option-label',
    'data-value' => 'choice-1',
    'tag' => 'span',
]);

If it's a good idea, i'll do it in another PR.

… and improve label rendering logic.

terabytesoftw · 2025-09-28T13:41:33Z

I'm thinking, if this way can support custom tag why dont make it consistent for
$field->checkbox( )->label('Custom Label', 'labelOptions' => [
    'class' => 'radio-option-label',
    'data-value' => 'choice-1',
    'tag' => 'span',
]);

done.

Copilot

Pull Request Overview

This PR enhances the ActiveField::label() method with a new tag option to control the wrapper element type and fixes how labelOptions work for checkbox/radio inputs when not enclosed by label. The enhancement maintains full backward compatibility while providing more flexibility for custom label rendering.

Key Changes:

Added tag option to label() method for customizing wrapper elements
Fixed labelOptions handling in checkbox/radio methods when enclosedByLabel is false
Added comprehensive test coverage for new functionality

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
`framework/widgets/ActiveField.php`	Core implementation of `tag` option in `label()` method and refactored checkbox/radio label handling
`tests/framework/widgets/ActiveFieldTest.php`	Comprehensive test coverage for new label functionality and improved test format
`framework/UPGRADE.md`	Documentation of new feature for upgrade guide
`framework/CHANGELOG.md`	Added entry for enhancement #20537

Comments suppressed due to low confidence (1)

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/framework/widgets/ActiveFieldTest.php

Copilot · 2025-09-29T22:29:42Z

framework/widgets/ActiveField.php

    public function label($label = null, $options = [])
    {
-        if ($label === false) {
+        if ($label === false || (isset($this->labelOptions['label']) && $this->labelOptions['label'] === false)) {


The condition check for $this->labelOptions['label'] === false seems unexpected here. The labelOptions array is typically for HTML attributes, not for controlling label visibility. This could create confusion and should be documented or reconsidered.

Suggested change

if ($label === false || (isset($this->labelOptions['label']) && $this->labelOptions['label'] === false)) {

if ($label === false) {

I think user should allowed to overwrite the label with newer value, isn't it ?

If set to `false`, the label content will be rendered as raw HTML without any wrapper tag.

except it's null

Correct the user can overwrite the label.

testLabelPriorityOfContent

I mean

$this->activeField(['label'=>false])->label('anything');

newer should be the final decision

Update docs.

I mean

$this->activeField(['label'=>false])->label('anything');

newer should be the final decision

@samdark How would you treat this edge case?

Label precedence.

$label parameter (highest priority).

options['label'] (only when $label === null).

Model attribute label (fallback).

If any of these equals false, the label won't render.

Arhell

lgtm

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/framework/widgets/ActiveFieldTest.php

framework/widgets/ActiveField.php

xicond · 2025-09-30T08:31:07Z

framework/widgets/ActiveField.php

    public function label($label = null, $options = [])
    {
-        if ($label === false) {
+        if ($label === false || (isset($this->labelOptions['label']) && $this->labelOptions['label'] === false)) {


I mean

$this->activeField(['label'=>false])->label('anything');

newer should be the final decision

terabytesoftw · 2025-09-30T11:34:23Z

@xicond

$this->activeField(['label'=>false])->label('anything'); done

Add more tests.

thks, for review 👍

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/framework/widgets/ActiveFieldTest.php

framework/widgets/ActiveField.php

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/framework/widgets/ActiveFieldTest.php

framework/widgets/ActiveField.php

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

framework/widgets/ActiveField.php

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

framework/widgets/ActiveField.php

tests/framework/widgets/ActiveFieldTest.php

framework/widgets/ActiveField.php

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-01T19:57:46Z

framework/widgets/ActiveField.php

+     */
+    protected function generateLabel(array $options): array
+    {
+        if (isset($options['label']) && $options['label'] !== false && $this->parts['{label}'] === '') {


[nitpick] Consider extracting the condition $this->parts['{label}'] === '' into a more descriptive variable or method name to improve readability, such as $isLabelEmpty or $this->isLabelEmpty().

Copilot · 2025-10-01T19:57:46Z

framework/widgets/ActiveField.php

+
+                unset($options['labelOptions']['tag']);
+
+                $this->labelOptions = array_merge($this->labelOptions, $options['labelOptions']);


[nitpick] The labelOptions merging could overwrite existing options unintentionally. Consider using a more explicit merge strategy or documenting the precedence behavior to avoid unexpected side effects.

feat(activefield): labelOptions are ignored when using custom label…

3220329

… with `enclosedByLabel = false` in `checkbox`/`radio` methods (yiisoft#20537).

terabytesoftw added the 22 Yii 2.2 label Sep 27, 2025

terabytesoftw linked an issue Sep 27, 2025 that may be closed by this pull request

ActiveField: Enhance label() method with tag option and fix labelOptions for checkbox/radio. #20537

Open

refactor(activefield): simplify label handling for radio and checkbox…

6daf260

… inputs.

terabytesoftw changed the title ~~feat(activefield): enhance label() method with tag option and fix labelOptions for checkbox/radio (#20537).~~ feat(activefield): Enhance label() method with tag option and fix labelOptions for checkbox/radio (#20537). Sep 28, 2025

feat(activefield): Enhance label method to support custom tag options…

13dcd79

… and improve label rendering logic.

terabytesoftw added 2 commits September 28, 2025 10:42

Update CHANGELOG.md.

98d82c7

Add notes for UPGRADE.md.

821e0cf

terabytesoftw added the type:feature label Sep 28, 2025

terabytesoftw changed the title ~~feat(activefield): Enhance label() method with tag option and fix labelOptions for checkbox/radio (#20537).~~ Enhance label() method in ActiveField with tag option and fix labelOptions for checkbox/radio (#20537). Sep 29, 2025

samdark approved these changes Sep 29, 2025

View reviewed changes

samdark requested a review from Copilot September 29, 2025 22:29

Copilot AI reviewed Sep 29, 2025

View reviewed changes

Arhell reviewed Sep 30, 2025

View reviewed changes

terabytesoftw added 2 commits September 30, 2025 05:32

Merge branch '22.0' into feat-20537

3ee13ad

Enhance documentation for label options in ActiveField::class.

3c0e03a

terabytesoftw requested a review from Copilot September 30, 2025 08:40

Copilot AI reviewed Sep 30, 2025

View reviewed changes

tests/framework/widgets/ActiveFieldTest.php Show resolved Hide resolved

framework/widgets/ActiveField.php Outdated Show resolved Hide resolved

framework/widgets/ActiveField.php Outdated Show resolved Hide resolved

Refactor label method to use ArrayHelper for improved readability.

9c6c8be

xicond approved these changes Sep 30, 2025

View reviewed changes

Update label handling in ActiveField::class.

137d399

Copilot AI review requested due to automatic review settings September 30, 2025 11:33

Copilot AI reviewed Sep 30, 2025

View reviewed changes

terabytesoftw added 2 commits September 30, 2025 08:36

Fix issue phpcs.

6d9f1c6

Apply fixed review Copilot.

aab7fd6

Copilot AI review requested due to automatic review settings September 30, 2025 11:47

Copilot AI reviewed Sep 30, 2025

View reviewed changes

terabytesoftw added 2 commits September 30, 2025 08:54

Apply fixed review Copilot.

5bdb9ee

Apply fixed review Copilot.

6aeab15

Copilot AI review requested due to automatic review settings September 30, 2025 12:01

Copilot AI reviewed Sep 30, 2025

View reviewed changes

framework/widgets/ActiveField.php Show resolved Hide resolved

framework/widgets/ActiveField.php Outdated Show resolved Hide resolved

terabytesoftw added 2 commits September 30, 2025 09:13

Apply fixed more review Copilot.

a3cd943

Merge branch '22.0' into feat-20537

e538593

Copilot AI review requested due to automatic review settings October 1, 2025 16:03

Copilot AI reviewed Oct 1, 2025

View reviewed changes

framework/widgets/ActiveField.php Show resolved Hide resolved

tests/framework/widgets/ActiveFieldTest.php Outdated Show resolved Hide resolved

framework/widgets/ActiveField.php Outdated Show resolved Hide resolved

Apply fixed Copilot review.

845442c

terabytesoftw marked this pull request as draft October 1, 2025 19:56

terabytesoftw marked this pull request as ready for review October 1, 2025 19:57

Copilot AI review requested due to automatic review settings October 1, 2025 19:57

Copilot AI reviewed Oct 1, 2025

View reviewed changes

	if ($label === false \|\| (isset($this->labelOptions['label']) && $this->labelOptions['label'] === false)) {
	if ($label === false) {


		unset($options['labelOptions']['tag']);

		$this->labelOptions = array_merge($this->labelOptions, $options['labelOptions']);

Uh oh!

Enhance label() method in ActiveField with tag option and fix labelOptions for checkbox/radio (#20537). #20546

Are you sure you want to change the base?

Enhance label() method in ActiveField with tag option and fix labelOptions for checkbox/radio (#20537). #20546

Conversation

terabytesoftw commented Sep 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

xicond commented Sep 27, 2025

Uh oh!

terabytesoftw commented Sep 27, 2025

Uh oh!

xicond commented Sep 28, 2025

Uh oh!

terabytesoftw commented Sep 28, 2025

Uh oh!

terabytesoftw commented Sep 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes:

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

xicond Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

terabytesoftw Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

xicond Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

terabytesoftw Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

terabytesoftw Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

terabytesoftw Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Arhell left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xicond Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

terabytesoftw commented Sep 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Enhance `label()` method in `ActiveField` with `tag` option and fix `labelOptions` for `checkbox`/`radio` (#20537). #20546

Enhance `label()` method in `ActiveField` with `tag` option and fix `labelOptions` for `checkbox`/`radio` (#20537). #20546

terabytesoftw commented Sep 27, 2025 •

edited

Loading

codecov bot commented Sep 27, 2025 •

edited

Loading

xicond Sep 30, 2025 •

edited

Loading