[#47317] - custom field named images overrides core article images in API response
- Pending
- Medium
- Build: 5.4-dev
- # 47317
- Diff
- Harsh63870:fixing-47301
- Pending continuous-integration/drone/pr Build is running Details
User tests: Successful: Unsuccessful:
Problem
When a custom field has the same name as a core article property (e.g. "images"),
the custom field value overwrites the core value in the API response, causing
core article images to return empty and the custom field to also go missing.
Root Cause
In prepareItem(), the code blindly assigned $item->{$field->name} without
checking if that property already existed as a core article property.
Fix
- Check for name collision using
property_exists($item, $field->name) - If collision detected, prefix the custom field key with
cf_ - Apply the same prefix logic consistently in
displayList(),displayItem()andprepareItem() - Register the prefixed key in both
fieldsToRenderItemandfieldsToRenderList
Result
- Core
imagesproperty is preserved as-is - Custom field named
imagesappears ascf_imagesin the response - Both single item (
/content/articles/{id}) and list (/content/articles) endpoints are fixed
Testing
Added Cypress test: keeps core article images when a custom field is named images
Fixes #47301
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | JavaScript Unit Tests |
Thanks for pointing that out.
you are right currently my fix only handles the issue in com_content I was mainly focused on the article endpoints and didn't think about the fact that custom fields are used in other components as well ... so it probably makes more sense to handle this at a more central level so every component using custom fields gets the fix.
Would it be better to move this logic somewhere like libraries/src/MVC/View/JsonApiView.php, or should it be handled through com_fields (maybe FieldsHelper)?
Happy to refactor the PR and make the solution global. Just wanted to know the preferred place for it.
| Labels |
Added:
Unit/System Tests
PR-5.4-dev
|
||
custom fields are also available in many other components. this only addresses com_content