Improve CMS Page URL Key comment with implications for reference updates #4970
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the help text for the CMS Page URL Key field in the admin interface to warn administrators about the potential impact of changing URL keys on existing references throughout the system.
- Updates the URL Key field note to include comprehensive warning about reference impacts
- Adds new translation entry for the enhanced help text
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| app/locale/en_US/Mage_Cms.csv | Adds translation entry for the enhanced URL Key help text |
| app/code/core/Mage/Adminhtml/Block/Cms/Page/Edit/Tab/Main.php | Updates the URL Key field note to use the more comprehensive warning text |
github-actions
bot
added
Component: Adminhtml
|
This will break comments for all shops that use locale packs. |
Over time, I have not been a supporter of making changes only in locale files. There are situations where it becomes time consuming to find a message because one is defined in a PHP file and another in a locale CSV file, requiring extra checks to understand what the actual correspondence is between the displayed message and its translation. However, I have been mostly alone in advocating for implementing changes directly in PHP files. Therefore, I will adjust the PR as requested. |
|
What does this PR improve?
This PR enhances the comment shown for the "URL Key" field in the CMS Page admin form. The new note informs administrators that changing the URL Key may require updating all references to the page in CMS blocks, widgets, layouts, templates, external/internal links, and any custom extensions or modules.
Why was this change made?
Previously, the only help text was "Relative to Website Base URL," which is technically accurate but does not warn about breaking references elsewhere in the site or custom code. Modifying the URL Key for a CMS Page can cause broken links or missing content if the identifier is used in:
{{page url="identifier"}})Adding this note helps administrators understand the potential impact and avoid unintended issues after changing the URL Key.
Before
After