Add WordPress.Security.SafeRedirect XML documentation #1742
Conversation
| <documentation title="Safe Redirect"> | ||
| <standard> | ||
| <
There was a problem hiding this comment.
I'd like to see this expanded - why must safe redirects be used? What is a safe redirect? Why does a non-safe redirect even exist? Where can I find out more about this concept? etc.
There was a problem hiding this comment.
Hi @marconmartins, thank you again for this PR. Mostly looking great.
I do concur with @GaryJones that it would be great if the generic rule explanation could be expanded a bit.
The following articles may help to get some inspiration:
- https://www.pluginvulnerabilities.com/2018/11/26/security-tip-for-wordpress-plugin-developers-use-wp_safe_redirect-instead-of-wp_redirect/
- https://wp-kama.com/function/wp_safe_redirect
Other than that, the docs are just missing the <em> ...</em> tags to highlight good/bad code, but we weren't that clear about that in the initial explanation, so sorry about that!
I look forward to the next iteration!
| <code_comparison> | ||
| <code title="Valid: Safe redirect."> | ||
| <
|
@marconmartins Just wondering if you'll have a chance to finish this off in the near future. If you haven't got time or lost interest, please let us know and we'll see if we can find someone to take over. |
|
Closing as fixed via #1826 which was merged quite a while ago. |
No description provided.