WordPress.org

Make WordPress Core

Opened 20 months ago

Closed 3 months ago

#38732 closed enhancement (fixed)

Document WP_Roles->role_objects as an array of WP_Role objects

Reported by: jdgrimes Owned by: johnbillion
Milestone: 5.0 Priority: normal
Severity: normal Version: 4.7
Component: Role/Capability Keywords: has-patch
Focuses: docs Cc:

Description

Currently the $role_objects property of the WP_Roles class is just documented as an array. It ought to be documented as an array of WP_Role objects instead: WP_Role[].

Attachments (1)

38732.diff (364 bytes) - added by stevenlinx 7 months ago.

Download all attachments as: .zip

Change History (5)

@stevenlinx
7 months ago

#1 @stevenlinx
7 months ago

  • Keywords has-patch added

#2 @johnbillion
7 months ago

Thanks for the patch. This is effectively blocked by #41756 as the docs parser hasn't been tested with this format yet. If everything works okay and nothing explodes, we can go ahead and start implementing this known array type format for docs.

#3 @johnbillion
7 months ago

  • Milestone changed from Awaiting Review to 5.0
  • Owner set to johnbillion
  • Status changed from new to reviewing

#4 @johnbillion
3 months ago

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

In 42870:

Docs: Document WP_Roles properties with typed array notation.

Props stevenlinx

Fixes #38732
See #41756

Note: See TracTickets for help on using tickets.