Abilities API: Add Ability Categories REST API controller #10380

gziolo · 2025-10-21T14:16:50Z

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

Follow-up for #9410.

Introduces a new REST API endpoint at wp-abilities/v1/categories to expose
ability categories through the WordPress REST API.

The new WP_REST_Abilities_V1_Categories_Controller provides:

GET /wp-abilities/v1/categories - Lists all ability categories with pagination
GET /wp-abilities/v1/categories/{slug} - Retrieves a single category by slug

Both endpoints require the read capability and return category data including
slug, label, description, and metadata. The collection endpoint supports pagination
with page and per_page parameters (default: 50, max: 100).

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 · 2025-10-21T14:17:07Z

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

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

github-actions · 2025-10-21T14:45:09Z

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

The Plugin and Theme Directories cannot be accessed within Playground.
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.

JasonTheAdams · 2025-10-21T15:58:42Z

src/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-categories-controller.php

This looks good! The only thing absent are hooks. I don't think we need a ton (not quite so many as WP_REST_Posts_Controller, but a few for filtering responses could be useful. Since it's all read-only I don't think we need actions.

We filter abilities only by category slug:

wordpress-develop/src/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-list-controller.php

Lines 96 to 107 in c6c922c

// Filter by ability category if specified.

$category = $request['category'];

if ( ! empty( $category ) ) {

$abilities = array_filter(

$abilities,

static function ( $ability ) use ( $category ) {

return $ability->get_category() === $category;

}

);

// Reset array keys after filtering.

$abilities = array_values( $abilities );

}

For v1, this should be a good starting point.

In the WordPress 7.0 release cycle, we should expand support for other filtering options after we sort out:

Proposal: Add a convienient way to filter the list of all registered abilities abilities-api#38

Sorry, I don't mean filtering via REST, I mean filtering via apply_filters(). 😄

I committed the changes as having the controller is the most important.

@JasonTheAdams, can you draft something explaining your proposal further? Do you want to filter the list by categories, individual items, or both? How about the endpoint with abilities? Should it have the same extensibility in place for consistency?

Introduces a new REST API endpoint at `wp-abilities/v1/categories` to expose ability categories through the WordPress REST API. The new `WP_REST_Abilities_V1_Categories_Controller` provides: - GET `/wp-abilities/v1/categories` - Lists all ability categories with pagination - GET `/wp-abilities/v1/categories/{slug}` - Retrieves a single category by slug Both endpoints require the `read` capability and return category data including slug, label, description, and metadata. The collection endpoint supports pagination with `page` and `per_page` parameters (default: 50, max: 100). Developed in #10380. Follow-up [61032]. Props gziolo, jason_the_adams, timothyblynjacobs. Fixes #64098. git-svn-id: https://develop.svn.wordpress.org/trunk@61045 602fd350-edb4-49c9-b593-d223f7449a82

github-actions · 2025-10-22T07:06:23Z

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 61045
GitHub commit: 871fd0e

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

Introduces a new REST API endpoint at `wp-abilities/v1/categories` to expose ability categories through the WordPress REST API. The new `WP_REST_Abilities_V1_Categories_Controller` provides: - GET `/wp-abilities/v1/categories` - Lists all ability categories with pagination - GET `/wp-abilities/v1/categories/{slug}` - Retrieves a single category by slug Both endpoints require the `read` capability and return category data including slug, label, description, and metadata. The collection endpoint supports pagination with `page` and `per_page` parameters (default: 50, max: 100). Developed in WordPress/wordpress-develop#10380. Follow-up [61032]. Props gziolo, jason_the_adams, timothyblynjacobs. Fixes #64098. Built from https://develop.svn.wordpress.org/trunk@61045 git-svn-id: https://core.svn.wordpress.org/trunk@60381 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Introduces a new REST API endpoint at `wp-abilities/v1/categories` to expose ability categories through the WordPress REST API. The new `WP_REST_Abilities_V1_Categories_Controller` provides: - GET `/wp-abilities/v1/categories` - Lists all ability categories with pagination - GET `/wp-abilities/v1/categories/{slug}` - Retrieves a single category by slug Both endpoints require the `read` capability and return category data including slug, label, description, and metadata. The collection endpoint supports pagination with `page` and `per_page` parameters (default: 50, max: 100). Developed in WordPress/wordpress-develop#10380. Follow-up [61032]. Props gziolo, jason_the_adams, timothyblynjacobs. Fixes #64098. Built from https://develop.svn.wordpress.org/trunk@61045 git-svn-id: http://core.svn.wordpress.org/trunk@60381 1a063a9b-81f0-0310-95a4-ce76da25c4cd

mukeshpanchal27 · 2025-10-22T11:02:46Z

src/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-categories-controller.php

+		$offset   = ( $page - 1 ) * $per_page;
+
+		$total_categories = count( $categories );
+		$max_pages        = ceil( $total_categories / $per_page );


Better to cast int here

Ok, I see other occurrences use (int). Good catch, thank you 👍🏻

Addressed with https://core.trac.wordpress.org/changeset/61047.

gziolo self-assigned this Oct 21, 2025

gziolo force-pushed the add/ability-categories-rest-controller branch from 994bfdc to 919511e Compare October 21, 2025 14:18

gziolo changed the title ~~Apply feedback from code review~~ Abilities API: Add Ability Categories REST API controller Oct 21, 2025

gziolo force-pushed the add/ability-categories-rest-controller branch from 919511e to cb95cdc Compare October 21, 2025 14:30

Apply feedback from code review

04c7a07

gziolo force-pushed the add/ability-categories-rest-controller branch from cb95cdc to 04c7a07 Compare October 21, 2025 14:32

gziolo mentioned this pull request Oct 21, 2025

Abilities API: Implement server-side registry with REST API endpoints #9410

Closed

15 tasks

JasonTheAdams reviewed Oct 21, 2025

View reviewed changes

gziolo requested a review from TimothyBJacobs October 21, 2025 16:22

github-actions bot closed this Oct 22, 2025

gziolo deleted the add/ability-categories-rest-controller branch October 22, 2025 07:26

gziolo mentioned this pull request Oct 22, 2025

Add new REST API endpoint for Ability Categories gziolo/wordpress-develop#3

Closed

mukeshpanchal27 reviewed Oct 22, 2025

View reviewed changes

gziolo mentioned this pull request Oct 23, 2025

Sync changes from WordPress core after 6.9 beta 1 WordPress/abilities-api#126

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Abilities API: Add Ability Categories REST API controller #10380

Abilities API: Add Ability Categories REST API controller #10380

Uh oh!

gziolo commented Oct 21, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

JasonTheAdams Oct 21, 2025

Uh oh!

gziolo Oct 21, 2025

Uh oh!

JasonTheAdams Oct 21, 2025

Uh oh!

gziolo Oct 22, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 22, 2025

Uh oh!

mukeshpanchal27 Oct 22, 2025

Uh oh!

gziolo Oct 22, 2025

Uh oh!

gziolo Oct 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	// Filter by ability category if specified.
	$category = $request['category'];
	if ( ! empty( $category ) ) {
	$abilities = array_filter(
	$abilities,
	static function ( $ability ) use ( $category ) {
	return $ability->get_category() === $category;
	}
	);
	// Reset array keys after filtering.
	$abilities = array_values( $abilities );
	}

Abilities API: Add Ability Categories REST API controller #10380

Abilities API: Add Ability Categories REST API controller #10380

Uh oh!

Conversation

gziolo commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Test using WordPress Playground

Some things to be aware of

Uh oh!

JasonTheAdams Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

gziolo Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

JasonTheAdams Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

gziolo Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 22, 2025

Uh oh!

mukeshpanchal27 Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

gziolo Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

gziolo Oct 22, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gziolo commented Oct 21, 2025 •

edited

Loading

gziolo Oct 22, 2025 •

edited

Loading