WordPress.org
Get WordPress

Make WordPress Core

Opened 12 years ago

Closed 12 years ago

#20622 closed enhancement (fixed)

Update phpdoc for register_post_type()

Reported by: jeremyfelt's profile jeremyfelt Owned by: ryan's profile ryan
Milestone: 3.4 Priority: normal
Severity: normal Version:
Component: Inline Docs Keywords: has-patch
Focuses: Cc:

Description

The phpdoc for register_post_type() can often be a source of confusion in its current state.

This patch cleans things up and attempts to better clarify the arguments without going in to too much detail.

A refresh to Codex has also just been made to reflect the clarifications made in this patch - ​http://codex.wordpress.org/Function_Reference/register_post_type

Attachments (2)

20622.patch​ (8.4 KB) - added by jeremyfelt 12 years ago.
20622.diff​ (8.5 KB) - added by jeremyfelt 12 years ago.
Corrected patch.

Download all attachments as: .zip

Change History (7)

@jeremyfelt
12 years ago

#1 @jeremyfelt
12 years ago

  • Component changed from Post Types to Inline Docs

#2 @nacin
12 years ago

  • Milestone changed from Awaiting Review to 3.4

Good first effort. "public - Whether posts of this type should be shown in the admin UI. Defaults to false." is still incorrect, I think.

#3 @jeremyfelt
12 years ago

Hrm. I think my patch got messed up. I'll resubmit in a few. The new public is:

"Whether a post type is intended for use publicly either via the admin interface or by front-end users. "

@jeremyfelt
12 years ago

Corrected patch.

#4 @jeremyfelt
12 years ago

Corrected patch uploaded as 20622.diff​. Non reversed.

#5 @ryan
12 years ago

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

In [20734]:

phpdoc updates for register_post_type(). Props jeremyfelt. fixes #20622

Note: See TracTickets for help on using tickets.