Fix incorrect return type in docblock for get_value() #43
Conversation
This file contains hidden or 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
| * @param string $name Config name. | ||
| * | ||
| * @return array | ||
| * @return string|null |
Member
There was a problem hiding this comment.
Suggested change
| * @return string|null | |
| * @return mixed |
Maybe this would be a little safer?
Contributor
Author
There was a problem hiding this comment.
I was thinking the same originally, but hinting nullable string makes it clear that the method does not cast the value to it's type, and maybe to some extent that undefined variables make it return null 🙂
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
WPConfigTransformer::get_value()never returns an array, but array is the return type being hinted in the associated docblock. I suggest changing it tostring|null. I'm not aware of a situation in which it can return anything else. Feel free to correct me if I'm wrong, but through testing with int, float, string, array, stdClass and undefined variables I haven't managed to get anything else out of it.