Skip to content

Docs: Move the oembed_min_max_width array shape into the filter docblock - #15264

Open
westonruter wants to merge 3 commits into
WordPress:trunkfrom
westonruter:fix/oembed-min-max-width-type-placement
Open

westonruter wants to merge 3 commits into
WordPress:trunkfrom
westonruter:fix/oembed-min-max-width-type-placement

Conversation

@westonruter

@westonruter westonruter commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Follow-up to r62719, which adopted clamp() in get_oembed_response_data() and added an inline /** @var array{ min: positive-int, max: positive-int } $min_max_width */ after the apply_filters() call. Placing a @var below the assignment it describes is confusing to read. It ended up there because the filter's docblock has to immediately precede apply_filters(), or else the wordpress.hookDocNoParams rule reports that the hook is undocumented.

This moves the shape into the filter docblock itself as a @phpstan-param, next to the @param hash 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 $min and $max keys are also marked Required. in the hash. That PR teaches HashNotationVisitor to read a Required. 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 @param hash 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. So Default 200. here describes the value core supplies, not a fallback for an omitted key. Even after #14457 is merged, the @phpstan-param is kept, because the hash only says int and the shape narrows the widths to positive-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

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The 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

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@westonruter
westonruter marked this pull request as ready for review October 30, 2026 18:55
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

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:

Props westonruter, dmsnell.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

@westonruter

Copy link
Copy Markdown
Member Author

@propsbot add @dmsnell

@westonruter
westonruter requested a review from dmsnell October 30, 2026 18:56
…into fix/oembed-min-max-width-type-placement
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant