Conversation
Deploying yoast-developer with
|
| Latest commit: |
b3c77da
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7fb1ff47.yoast-developer.pages.dev |
| Branch Preview URL: | https://add-abilities-api-docs.yoast-developer.pages.dev |
pls78
requested changes
Apr 20, 2026
| This documentation explains what is the Abilities API and how [Yoast SEO](https://yoast.com/product/yoast-seo-wordpress/) integrates with it. | ||
|
|
||
| ## What is the Abilities API? | ||
| [Abilities API was introduced in WordPress 6.9](https://developer.wordpress.org/news/2025/11/introducing-the-wordpress-abilities-api/), as a new standardized way for plugins to expose what they can do. It allows plugins to do so by providing: |
Member
There was a problem hiding this comment.
I would invert the sentences here, starting with what Abilities API is and the when it has been released
|
|
||
| ## What is the Abilities API? | ||
| [Abilities API was introduced in WordPress 6.9](https://developer.wordpress.org/news/2025/11/introducing-the-wordpress-abilities-api/), as a new standardized way for plugins to expose what they can do. It allows plugins to do so by providing: | ||
| * A **registry** where plugins declare their capabilities (also know as `abilities`) with structured input/output schemas. |
Member
There was a problem hiding this comment.
I don't know if it is just me, but I still don't get what abilities/capabilities are in the plugin context
Contributor
Author
There was a problem hiding this comment.
I think this might make it a bit clearer? In any case, I think everything that comes after elaborates that part.
| * A **registry** where plugins declare their capabilities (also know as `abilities`) with structured input/output schemas. | ||
| * A **central REST discovery endpoint** (`/wp-json/wp-abilities/v1/abilities`) where any client/plugin can list everything that's available. | ||
| * A **standardized execution endpoint** (`/run`) to invoke any registered ability. | ||
| * **Permission checks** baked into every ability, so access control is consistent. |
Member
There was a problem hiding this comment.
I perceived "bakes" as being a bit too informal here 😁
| That way, Yoast SEO exposes the results of its analyses to authenticated AI agents, enabling users to use AI capabilities to easily navigate through useful SEO data of their website and create reports, map out plans and perform SEO-related actions accordingly. | ||
|
|
||
| ### Third-party code | ||
| A more traditional way to consume the Yoast SEO Abilities API, any plugin that is interested in building features on top of Yoast SEO Analyses can now use the new WP REST API endpoints, to reliably get information about a website's recent posts, in a structured way. |
Member
There was a problem hiding this comment.
The first and second sentences feel disjoint, and I think there are a bit too much commas 😅
Suggestion:
For plugins interested in building features on top of Yoast SEO Analyses, a more traditional way to consume the Yoast SEO Abilities API would be to use the new WP REST API endpoints: this way information about a website's recent posts can be reliably retrieved in a structured way.
Contributor
Author
There was a problem hiding this comment.
Yeah, fair enough. I revamped your suggestion here, hope it's better!
…age-ability.md Co-authored-by: Paolo L. Scala <68744851+pls78@users.noreply.github.com>
…lity.md Co-authored-by: Paolo L. Scala <68744851+pls78@users.noreply.github.com>
Co-authored-by: Paolo L. Scala <68744851+pls78@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #
Summary
Relevant technical choices
Technical choices that affect more than this issue:
Test instructions
This PR can be acceptance tested by following these steps:
1.
1.
1.
Quality assurance
_redirectsfile in the root of the project.