Skip to content

REST API: Cache route maps in WP_REST_Server::get_routes() - #11694

Open
wppoland wants to merge 4 commits into
WordPress:trunkfrom
wppoland:trac/39473
Open

wppoland wants to merge 4 commits into
WordPress:trunkfrom
wppoland:trac/39473

Conversation

@wppoland

@wppoland wppoland commented May 3, 2026 •

Copy link
Copy Markdown

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

get_routes() is called multiple times per request (route matching, schema generation, OPTIONS handling). The result is deterministic between route registrations, so this PR memoizes the per-namespace map on the server instance and busts the cache whenever register_route() mutates $this->endpoints.

Tests cover:

  • rest_endpoints filter fires once across repeated calls
  • Cache keyed by namespace
  • Cache invalidated when a new route is registered
  • Cached and uncached results are identical

Note for reviewers: caching the post-rest_endpoints-filter result means filters added after the first call to get_routes() no longer take effect for that request. This matches the perf goal but is a documented filter-contract change worth weighing - happy to refactor to cache only the pre-filter map if reviewers prefer.

Use of AI Tools

AI assistance: Yes
Tool(s): Antigravity IDE
Model(s): Gemini 2.5 Pro
Used for: Code analysis, conflict resolution, test suite updates, and patch verification. All changes were manually reviewed and tested locally.


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

github-actions Bot commented May 3, 2026

Copy link
Copy Markdown

Hi @wppoland! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions

github-actions Bot commented May 3, 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. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props motylanogha.

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

@github-actions

github-actions Bot commented May 3, 2026

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.

`get_routes()` is called multiple times per request (route matching, schema generation, OPTIONS handling). The result is deterministic between route registrations, so this commit memoizes the per-namespace map on the server instance and busts the cache whenever `register_route()` mutates `$this->endpoints`.

Adds tests covering:

* `rest_endpoints` filter fires once across repeated calls.
* Cache keyed by namespace.
* Cache invalidation when a new route is registered.
* Cached and uncached results are identical.

Note for reviewers: caching the post-`rest_endpoints`-filter result means filters added after the first call to `get_routes()` no longer take effect for that request. This matches the perf goal but is a documented filter-contract change worth weighing.

See #39473.
@wppoland

Copy link
Copy Markdown
Author

Rebased cleanly onto current trunk to resolve the conflict in WP_REST_Server::get_routes() (incorporating the trunk @phpstan-var annotation) and dropped the redundant PHPStan baseline commit. All 133 Tests_REST_Server tests pass cleanly locally with 0 PHPCS violations.

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