Skip to content

REST API: Document integer property names and patterns in the pattern property helpers. - #16143

Open
ekamran wants to merge 1 commit into
WordPress:trunkfrom
ekamran:shifteq/rest-pattern-property-int
Open

ekamran wants to merge 1 commit into
WordPress:trunkfrom
ekamran:shifteq/rest-pattern-property-int

Conversation

@ekamran

@ekamran ekamran commented Nov 21, 2026

Copy link
Copy Markdown

rest_find_matching_pattern_property_schema() documents @param string $property, and rest_validate_json_schema_pattern() documents @param string $pattern and @param string $value. Each can come from an array key, and PHP stores a numeric key such as "123" as the integer 123. REST requests decode JSON bodies into arrays, so a numeric property name or patternProperties key reaches these functions as an integer.

Trac ticket: https://core.trac.wordpress.org/ticket/66770

What changes

  • @param string|int $property in rest_find_matching_pattern_property_schema().
  • @param string|int $pattern and @param string|int $value in rest_validate_json_schema_pattern().
  • A "numeric pattern key" data set in Tests_REST_API_RestFindMatchingPatternPropertySchema: the pattern '123' (an integer key) matches the property a123. The function's integer property name case is already covered there.
  • No change to how the functions behave.

Testing

  • var_dump( array_keys( json_decode( '{"123":1}', true ) ) ); prints int(123).
  • vendor/bin/phpunit --filter '^Tests_REST_API_RestFindMatchingPatternPropertySchema::': OK (8 tests, 8 assertions). With a temporary if ( ! is_string( $pattern ) ) { return false; } in rest_validate_json_schema_pattern(), only the new data set fails.
  • With a temporary log of gettype() in both functions, the existing tests in Tests_JSON_Schema, Tests_REST_API, WP_Test_REST_Schema_Validation, WP_Test_REST_Schema_Sanitization, Tests_Abilities_API_WpRegisterCoreAbilities and Tests_REST_Server pass integer property names from rest_validate_object_value_from_schema() (30 calls), wp_prepare_json_value_for_client() (2) and rest_filter_response_by_context() (1).
  • PHPCS reports nothing on the two changed files, and PHPStan (phpstan.neon.dist) reports nothing on rest-api.php.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code and Codex
Used for: Investigation, code, tests, local testing and PR wording. I reviewed the reasoning, the code and the test results, and I take responsibility for the contribution.


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.

@github-actions

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 ekamran.

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 or WordPress.org 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.

@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.

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