Fix typo in prefix_data_arg_sanitize_callback doc on the Routes and Endpoints page
#169
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
fix typo in `prefix_data_arg_sanitize_callback` doc
Rahmon
changed the title
prefix_data_arg_sanitize_callback doc in Routes and Endpoints pageprefix_data_arg_sanitize_callback doc on the Routes and Endpoints page
kadamwhite
requested changes
Jan 15, 2024
| @@ -516,7 +516,7 @@ function prefix_data_arg_validate_callback( $value, $request, $param ) { | |||
| * @param mixed $value Value of the 'filter' argument. | |||
| * @param WP_REST_Request $request The current request object. | |||
| * @param string $param Key of the parameter. In this case it is 'filter'. | |||
| * @return WP_Error|boolean | |||
| * @return string | |||
There was a problem hiding this comment.
Thanks for the catch on the boolean -> string issue!
Suggested change
| * @return string | |
| * @return WP_Error|string |
I do think we need to document the option to return a WP_Error: This particular function does not return one, but it is valid, and there are cases where it can be useful to return an error from a sanitizer.
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.
This PR fixes the tag
@returnsince the return of the functionprefix_data_arg_sanitize_callbackis a string:return sanitize_text_field( $value );