Repository navigation
Docs: Move the oembed_min_max_width array shape into the filter docblock - #15264
westonruter wants to merge 3 commits into
Conversation
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. Props Bot commandsYou can trigger Props Bot actions by commenting on this PR:
|
…into fix/oembed-min-max-width-type-placement
Follow-up to r62719, which adopted
clamp()inget_oembed_response_data()and added an inline/** @var array{ min: positive-int, max: positive-int } $min_max_width */after theapply_filters()call. Placing a@varbelow the assignment it describes is confusing to read. It ended up there because the filter's docblock has to immediately precedeapply_filters(), or else thewordpress.hookDocNoParamsrule reports that the hook is undocumented.This moves the shape into the filter docblock itself as a
@phpstan-param, next to the@paramhash it refines, and removes the inline@var. The filtered value's type is now declared once, where the hook is documented.In anticipation of #14457 being merged, the
$minand$maxkeys are also markedRequired.in the hash. That PR teachesHashNotationVisitorto read aRequired.sentence, first or last in a key's description, as marking the key required. Until it lands, the marker has no effect on analysis.By default, the hash notation PHPStan extension reads the keys of a
@paramhash as optional, since a caller may pass a subset of them. That doesn't fit a filtered value: core always passes both keys, and a callback must return both, since they are read unconditionally. SoDefault 200.here describes the value core supplies, not a fallback for an omitted key. Even after #14457 is merged, the@phpstan-paramis kept, because the hash only saysintand the shape narrows the widths topositive-int.Trac ticket: https://core.trac.wordpress.org/ticket/65817
Use of AI Tools
AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5.5
Used for: Locating the related PR for the
Required.hash marker and drafting this description; the code change was authored and reviewed by me.This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.
🤖 Generated with Claude Code