WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#15947 closed defect (bug) (fixed)

`register_post_status` inline docs are inaccurate

Reported by: simonwheatley Owned by:
Milestone: 3.1 Priority: normal
Severity: normal Version: 3.1
Component: Inline Docs Keywords: has-patch
Focuses: Cc:

Description

The current inline docs describe the public index of the optional arguments as "Whether posts of this status should be shown in the admin UI. Defaults to true.", whereas actually public controls whether a post is viewable on the public (i.e. front end) of the site. Attached diff corrects this and adds description for other optional args.

Attachments (1)

register_post_status docs.diff (1.1 KB) - added by simonwheatley 3 years ago.
Corrects docs, adds additional information

Download all attachments as: .zip

Change History (3)

simonwheatley3 years ago

Corrects docs, adds additional information

comment:1 nacin3 years ago

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

(In [17158]) Correct the docs for register_post_status. fixes #15947, props simonwheatley.

comment:2 nacin3 years ago

  • Milestone changed from Awaiting Review to 3.1
Note: See TracTickets for help on using tickets.