Adding ability_class information and example #122

jonathanbossenger · 2025-10-15T18:12:54Z

WIP, needs to be tested to verify.

codecov · 2025-10-15T18:14:11Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.65%. Comparing base (bb0ef4a) to head (0aae7bb).
⚠️ Report is 1 commits behind head on docs/prepare-6.9.

Additional details and impacted files

@@                 Coverage Diff                 @@
##             docs/prepare-6.9     #122   +/-   ##
===================================================
  Coverage               86.65%   86.65%           
  Complexity                148      148           
===================================================
  Files                      18       18           
  Lines                     982      982           
  Branches                   89       89           
===================================================
  Hits                      851      851           
  Misses                    131      131

Flag	Coverage Δ
javascript	`93.04% <ø> (ø)`
unit	`84.70% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

gziolo

I read the changes proposed and everything seemed to be correct. Nice understanding of the use cases it tries to cover. It’s also primarily for projects offering collections of abilities that share similar characteristics like logging, debugging, social permission checks, etc.

justlevine

Did a quick scan from my phone. mostly nits

justlevine · 2025-10-15T20:07:17Z

docs/php-api.md

+- Your custom class **must** extend `WP_Ability`
+- The custom class is only used to instantiate the ability - the `ability_class` parameter is not stored as a property of the ability
+- You can override protected methods like `do_execute()`, `validate_input()`, or `validate_output()` to customize behavior
+- You can add public methods to provide additional functionality specific to your ability


They can add any sort of method, not sure if we want to encourage public methods with an explicit callout.

Suggested change

- You can add public methods to provide additional functionality specific to your ability

- You can add custom methods to provide additional functionality specific to your ability

docs/php-api.md

justlevine · 2025-10-15T20:13:56Z

docs/php-api.md

+     * to customize behavior before or after the standard execution.
+     *
+     * @param mixed $input Optional. The input data for the ability.
+     * @return mixed|WP_Error The result of the ability execution.


Suggested change

* @return mixed|WP_Error The result of the ability execution.

* @return mixed|\WP_Error The result of the ability execution.

Alternatively, this could be a lovely place to demonstrate {@inheritDoc} and leave off the types annotations for better future compat

justlevine · 2025-10-15T20:14:19Z

docs/php-api.md

+     * to perform validation logic that's specific to this ability.
+     *
+     * @param int $post_id The post ID to validate.
+     * @return true|WP_Error True if valid, WP_Error if invalid.


Suggested change

* @return true|WP_Error True if valid, WP_Error if invalid.

* @return true|\WP_Error True if valid, WP_Error if invalid.

justlevine · 2025-10-15T20:14:36Z

docs/php-api.md

+        // Check if the post exists
+        $post = get_post( $post_id );
+        if ( ! $post ) {
+            return new WP_Error(


Suggested change

return new WP_Error(

return new \WP_Error(

justlevine · 2025-10-15T20:14:43Z

docs/php-api.md

+
+        // Check if the post is published
+        if ( 'publish' !== $post->post_status ) {
+            return new WP_Error(


Suggested change

return new WP_Error(

return new \WP_Error(

jonathanbossenger · 2025-10-15T20:38:59Z

@gziolo @justlevine sorry, this wasn't mean to be reviewed yet, still a WIP.

github-actions · 2025-10-16T07:52:57Z

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: jonathanbossenger <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: justlevine <[email protected]>

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

jonathanbossenger · 2025-10-16T07:53:08Z

Merging this into the proper docs/prepare-6.9 branch so it can all be reviewed there.

* Docs refactor in prepartion for WordPress 6.9 Moved all PHP related docs to the php-api.md Created new README.md file with correct doc ordering Removed doc file numbering Updating main repo README.md doc links * Updating hooks Adding reference for abilities_api_init Moving hook registration in code examples above callback function for better readability * Adding other category functions to PHP API * Update README.md with direct link to docs README * Adding ability_class information and example (#122) * Adding ability_class information and example * Adding contributing docs to Documenation section in the readme * Fixing outdated link * PR review updates * Adding REST API docs updates from #120 * JavaScript client updates from #120 Co-authored-by: jonathanbossenger <[email protected]> Co-authored-by: gziolo <[email protected]> Co-authored-by: aaronware <[email protected]> Co-authored-by: galatanovidiu <[email protected]>

Adding ability_class information and example

920718b

gziolo reviewed Oct 15, 2025

View reviewed changes

justlevine reviewed Oct 15, 2025

View reviewed changes

Simplify example

25b4dec

Early review tweaks

0aae7bb

jonathanbossenger marked this pull request as ready for review October 16, 2025 07:52

jonathanbossenger merged commit fd9c918 into docs/prepare-6.9 Oct 16, 2025
21 of 36 checks passed

jonathanbossenger deleted the docs/prepare-6.9-ability_class branch October 16, 2025 07:53

jonathanbossenger mentioned this pull request Oct 17, 2025

Docs rework in preparation for WP 6.9 #117

Merged

	- You can add public methods to provide additional functionality specific to your ability
	- You can add custom methods to provide additional functionality specific to your ability

	* @return mixed\|WP_Error The result of the ability execution.
	* @return mixed\|\WP_Error The result of the ability execution.

	* @return true\|WP_Error True if valid, WP_Error if invalid.
	* @return true\|\WP_Error True if valid, WP_Error if invalid.

Adding ability_class information and example #122

Adding ability_class information and example #122

Uh oh!

Conversation

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

gziolo left a comment

Choose a reason for hiding this comment

Uh oh!

justlevine left a comment

Choose a reason for hiding this comment

Uh oh!

justlevine Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

justlevine Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

justlevine Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

justlevine Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

justlevine Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

justlevine Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

jonathanbossenger commented Oct 15, 2025

Uh oh!

github-actions bot commented Oct 16, 2025

Uh oh!

jonathanbossenger commented Oct 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jonathanbossenger commented Oct 15, 2025 •

edited

Loading

codecov bot commented Oct 15, 2025 •

edited

Loading