Add documentation for WordPress.DB.RestrictedFunctions #2453
Conversation
There was a problem hiding this comment.
@paulgibbs Thank you so much for getting this written up!
I've left some small remarks inline, but those are all small stuff, the principle of the docs looks good to me.
| > | ||
| <standard> | ||
| <![CDATA[ | ||
| Avoid touching the database directly with PHP library functions. Use the $wpdb object and associated functions instead. |
There was a problem hiding this comment.
| Avoid touching the database directly with PHP library functions. Use the $wpdb object and associated functions instead. | |
| Avoid touching the database directly with PHP library functions. Use the $wpdb object and associated functions instead. |
The indentation should always be multiples of 4, so this should either have 8 spaces or 4 spaces indentation, not 6.
| Avoid touching the database directly with PHP library functions. Use the $wpdb object and associated functions instead. | ||
| ]]> | ||
| </standard> | ||
| <code_comparison> |
There was a problem hiding this comment.
Could you please reverse the examples ?
The left side should always be the "Valid" code sample, the right side, the "Invalid" code sample.
| ); | ||
| ]]> | ||
| </code> | ||
| <code title="Valid: Use WordPress functions"> |
There was a problem hiding this comment.
| <code title="Valid: Use WordPress functions"> | |
| <code title="Valid: Using a WordPress function to fetch posts"> |
| ); | ||
| ]]> | ||
| </code> | ||
| <code title="Valid: Use WordPress functions"> |
There was a problem hiding this comment.
| <code title="Valid: Use WordPress functions"> | |
| <code title="Valid: Using WordPress functions to insert a post"> |
jrfnl
added
Status: Awaiting feedback
Focus: DB
and removed
Status: Review ready
labels
|
@paulgibbs Just checking in: did you have any questions about the review or are you good to proceed ? |
|
@paulgibbs, I was just wondering if you'll have a chance to finish this off in the near future. It would be great if this PR could be included in the next WPCS release. 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. Thanks! |
Related to #1722