Add documentation for WordPress.DB.RestrictedFunctions #2453
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
jrfnl
reviewed
Jun 13, 2024
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.
Suggested change
| 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.
Suggested change
| <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.
Suggested change
| <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 ? |
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.
Related to #1722