Update cleanForSlug() to remove additional non-word characters #21007
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Size Change: +9 B (0%) Total Size: 857 kB
ℹ️ View Unchanged
|
For posterity's sake, the reference implementation: https://github.com/WordPress/wordpress-develop/blob/5.3.2/src/wp-includes/formatting.php#L2145 |
aduth
approved these changes
Mar 31, 2020
There was a problem hiding this comment.
This seems like a reasonable change to me.
Do you know of any usage of cleanForSlug which may have relied on this behavior, broken as it may have been, for which these changes might cause some unforeseen incompatibility?
If the idea is for it to adhere to core's equivalent treatment of sanitize_title, it could be a good idea (perhaps separately from here) to include some or all of its test cases:
- https://github.com/WordPress/wordpress-develop/blob/master/tests/phpunit/tests/formatting/SanitizeTitleWithDashes.php
- https://github.com/WordPress/wordpress-develop/blob/master/tests/phpunit/tests/formatting/SanitizeTitle.php
- https://github.com/WordPress/wordpress-develop/blob/master/tests/phpunit/tests/formatting/RemoveAccents.php
|
I have another branch I started for duplicating |
gziolo
added
[Package] Url
|
Should we add a note in the changelog of the url package? It looks like it can be merged otherwise. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This updates the
cleanForSlug()function to remove punctuation characters that would get removed bysanitize_title()upon publishing.This fixes the original issue from #12907 regarding punctuation in the slug. It doesn't resolve the related issues referenced there that were opened for characters in other languages (such as German and Danish) not being converted properly. If we merge this and close #12907, we may want to reopen one of those that was closed as a duplicate in order to keep a more accurate record.
On investigating removing other punctuation, I realized
sanitize_title()allows underscores in slugs, so I adjusted the function to allow those, but to remove any other non-hyphen punctuation. I also removed thetoLowerdependency and switched to.toLowerCase()How has this been tested?
Used identical strings with a variety of characters in the classic editor and in the current editor to test how they compared. Also updated the unit tests to reflect the new characters that should be removed.
Screenshots
Here is a sample string in the classic editor:
Vs the block editor after this change:
Checklist: