WordPress.org
Get WordPress

Make WordPress Core

Opened 8 weeks ago

Closed 7 weeks ago

Last modified 6 weeks ago

#64134 closed defect (bug) (fixed)

Abilities API: Improve inline documentation

Reported by: jorbin's profile jorbin Owned by: gziolo's profile gziolo
Milestone: 6.9 Priority: normal
Severity: normal Version:
Component: AI Keywords: has-patch
Focuses: docs Cc:

Description

This was discussed in ​https://github.com/WordPress/wordpress-develop/pull/9410 and decided to defer until after beta1.

Fleshing out the phpdocs for the extender functions in https://core.trac.wordpress.org/browser/trunk/src/wp-includes/abilities-api.php should make it easier for people working with the abilities API

Change History (8)

This ticket was mentioned in ​Slack in #core by amykamala. ​View the logs.
7 weeks ago

#2 @gziolo
7 weeks ago

  • Owner set to gziolo
  • Status changed from new to accepted

#3 @jorbin
7 weeks ago

  • Component changed from General to AI

This ticket was mentioned in ​PR #10412 on ​WordPress/wordpress-develop by ​@gziolo.
7 weeks ago #4

  • Keywords has-patch added

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

Adds comprehensive file header documentation covering API overview, usage guide, naming conventions, schema definitions, callbacks, REST API integration, and best practices. Enhances all function PHPDocs with detailed descriptions, practical code examples, cross-references, and clearer parameter documentation.

#5 @gziolo
7 weeks ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 61067:

Abilities API: Improve inline documentation

This was discussed in ​https://github.com/WordPress/wordpress-develop/pull/9410 and decided to defer until after beta1.

Fleshing out the phpdocs for the extender functions in https://core.trac.wordpress.org/browser/trunk/src/wp-includes/abilities-api.php should make it easier for people working with the abilities API

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10412.

Follw-up [61032].

Props jorbin, gziolo, mukesh27, jason_the_adams, westonruter.
Fixes #64134.

#7 @gziolo
6 weeks ago

In 61086:

Abilities API: Improve annotations documentation and add permission callback validation

Code quality changes included:

  • Expands annotations parameter documentation with detailed descriptions for readonly,

destructive, and idempotent properties.

  • Standardizes type order from null|bool to bool|null per coding standards.
  • Adds validation check to ensure permission callback is callable before invocation.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10431.

Follow-up for [61067], [61032].
See #64134.

Note: See TracTickets for help on using tickets.