Skip to content

Change the deprecation message for null attribute values #3307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mpdude wants to merge 8 commits into
base: 2.x
Choose a base branch
from
+5 −1
Open

Change the deprecation message for null attribute values #3307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
68f43d0
Change the deprecation message for `null` attribute values
mpdude Jan 19, 2026
8356039
Update the CHANGELOG
mpdude Jan 19, 2026
dfd613f
Revert inadvertent change
mpdude Jan 19, 2026
00d04c7
Update src/TwigComponent/CHANGELOG.md
mpdude Jan 20, 2026
ef4e4cf
Change the deprecation message
mpdude Jan 20, 2026
3f59277
Update src/TwigComponent/src/ComponentAttributes.php
mpdude Jan 21, 2026
f74df6d
Move CHANGELOG entry to the right version
mpdude Jan 21, 2026
c24502f
Fix another version number
mpdude Jan 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/TwigComponent/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## 2.33

- Deprecate using `null` to add an attribute. Starting in `3.0`, passing `true` explicitly sets the attribute, while passing `false` or `null` omits it.

## 2.32

- Add option `profiler.collect_components` to control component data collection
Expand Down
2 changes: 1 addition & 1 deletion src/TwigComponent/src/ComponentAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public function __toString(): string
}

if (null === $value) {
trigger_deprecation('symfony/ux-twig-component', '2.8.0', 'Passing "null" as an attribute value is deprecated and will throw an exception in 3.0.');
trigger_deprecation('symfony/ux-twig-component', '2.33.0', 'Passing null as value to set an attribute is deprecated, pass true instead. In 3.0, the null value will remove the attribute.');
$value = true;
Copy link
Member

@smnandre smnandre Jan 19, 2026

Choose a reason for hiding this comment

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

Not sure we should precise the key... I mean maybe we should not suggest passing null is deprecated for that attribute only.

"To keep the current result, pass true instead."

I think with the various changes we plan, we should avoid using "current" / "previous" / "next" or maintaining (or reading) the docs will become quickly really hard.

What about something like "Use true to add the attribute, null or false to remove it"

Copy link
Author

@mpdude mpdude Jan 20, 2026

Choose a reason for hiding this comment

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

I will try to reword that.

My initial idea was that it might make it easier for users to understand which attribute to search for. But I also realized that people might be collecting and grouping deprecation messages by type, and so having a different message for each attribute might not be helpful to them either.

Also, for example the XmlFileReader deprecated in Symfony 7.4 only says XML is deprecated but does not give the file name. So, omitting the attribute name will be in line with that.

Copy link
Author

@mpdude mpdude Jan 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Now it's

Passing null as value to set an attribute is deprecated, pass true instead. In 3.0, the null value will remove the attribute.

}

Expand Down
Loading