(fix): correct parameter and return type #2537
Merged
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.
Description of the Change
The properties
decay
andwidth
have incorrect type hints in the comments:They are now 'hinted' as strings: https://10up.github.io/ElasticPress/includes_classes_Feature_Search_Search.php.html#line481
This made our application crash (throw an exception), as the return was incorrect.
Alternate Designs
These properties should be corrected to reflect the correct type. Maybe even forced?
Benefits
Better understanding what a user should return. Especially with PHP7+/8+ using better type-hinting.
Possible Drawbacks
None I can think about.
Verification Process
Only comments are changed with this PR. Maybe, if the returned value would be forced to the correct type, more validation is required.
Checklist:
Applicable Issues
None.
Changelog Entry
epwr_decay
andepwr_weight
hook.