[in progress] Abilities API: Add REST-level pagination to the run controller

[jorgefilipecosta]

Summary

Adds standard, opt-in collection pagination to the Abilities REST run controller, so list-returning abilities get the same X-WP-Total / X-WP-TotalPages headers (and out-of-range handling) as the core REST collection endpoints — without each ability reinventing it.

How it works

An ability opts in by setting a truthy pagination meta value. Such an ability accepts page/per_page input and returns integer total and total_pages alongside its collection. The run controller then:

• emits X-WP-Total and X-WP-TotalPages headers from those values,
• returns a 400 rest_ability_invalid_page_number when the requested page is beyond the available range, and
• returns the ability's result body unchanged, so non-REST callers (and clients ignoring the headers) keep the totals.

Abilities without the pagination meta are unaffected.

Tests

tests/phpunit/tests/rest-api/wpRestAbilitiesV1RunControllerPagination.php registers a self-contained paginated test ability and asserts header emission, the unchanged body, the out-of-range 400, and that the last page is allowed.

[github-actions]

Hi there! 👋

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:

• PHP Coding Standards
• CSS Coding Standards
• HTML Coding Standards
• JavaScript Coding Standards
• Accessibility Coding Standards
• Inline Documentation Standards

Thank you,
The WordPress Project

[github-actions]

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.