Suggestion for code comment in sanitize_user()

[ace100]

I spent a long time trying to understand the following comment and code at ​https://developer.wordpress.org/reference/functions/sanitize_user/:

// Kill octets.
$username = preg_replace( '|%([a-fA-F0-9][a-fA-F0-9])|', '', $username );

I think it would be better if the comment was "remove percent-encoded characters".

[SergeyBiryukov]

Hi there, welcome to WordPress Trac! Thanks for the ticket.

Yes, that sounds like a better comment. Would you be interested in ​creating a patch?

Additionally, the "Kill entities" comment directly below can probably be replaced with "Remove HTML entities".

Moving to 6.2, as this only affects code comments and can still be committed in beta.

Hi there!

I've made some changes to the sanitize_user() function to clarify the use of special characters in the comment. Specifically, I updated the comment to reflect that the function removes HTML entities and percent-encoded characters, rather than "killing" them.

Please review my changes and let me know if there are any issues or further improvements that need to be made. Thanks for your help!

Fixes #57712.

Trac ticket: https://core.trac.wordpress.org/ticket/57712

[codemonksuvro]

PR looks fine! thanks @tanjimtc71

[SergeyBiryukov]

In 55346:

Docs: Improve code comments in some sanitizing functions.

This aims to clarify a few inline comments related to removing percent-encoded characters and HTML entities.

Affected functions:

• sanitize_user()
• sanitize_title_with_dashes()
• sanitize_html_class()
• _sanitize_text_fields()
• get_comments_number_text()

Follow-up to [465], [3454], [11433], [12503], [37987].

Props ace100, tanjimtc71, codemonksuvro, SergeyBiryukov.
Fixes #57712.

Thanks for the PR! Merged in r55346 as part of a few other similar edits.