Consider sanitize_url a sanitization function. - Githubissues

10up / phpcs-composer

Official 10up PHPCS rules.

MIT License

48 stars 8 forks source link

Consider sanitize_url a sanitization function. #44

Closed peterwilsoncc closed 1 year ago

peterwilsoncc commented 1 year ago

Description of the Change

Add sanitize_url() as a custom sanitization function for the purpose of user input.

The current release of WPCS doesn't include it as such due to it being deprecated at the time it was released. Per the issue, it's now undeprecated.

Closes #42 Follow up to PR #43

How to test the Change

Install the sniffs using this branch composer require "10up/phpcs-composer":"dev-sanitize-url-undeprecated"
Add a basic phpcs file to include the 10up sniffs per readme instructions.
Add all security related rules to the config file <rule ref="WordPress.Security"/>
In a php file, include a call to sanitize_url( wp_unslash( $_GET['test'] ) );
Ensure the sniffs do not show a warning.

Changelog Entry

Added - Consider sanitize_url() a sanitization function.

Credits

Props @peterwilsoncc, @dkotter, @darylldoyle

Checklist:

[x] I agree to follow this project's Code of Conduct.
[ ] I have updated the documentation accordingly.
[ ] I have added tests to cover my change.
[x] All new and existing tests pass.