[Docblock] Add return type to defer() helper #56534
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.
Summary
This pull request adds a missing
@return
docblock to thedefer()
global helper defined inIlluminate\Support\functions.php
.The helper returns either a
DeferredCallback
or aDeferredCallbackCollection
, depending on whether a callable is passed. Currently, the docblock does not specify the return type when$callback
isnull
, which can negatively impact IDE autocompletion and static analysis.Benefits
Why This Is Safe
Related
This helper is part of the newer
Illuminate\Support\defer()
system introduced for deferring callbacks, and this docblock ensures full developer insight into the return behavior of the helper.