Correct the docs for register_post_status. fixes #15947, props simonwheatley.

git-svn-id: http://svn.automattic.com/wordpress/trunk@17158 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
nacin 2010-12-26 22:45:34 +00:00
parent 16b6d35d23
commit 84119f6e0b

View File

@ -617,8 +617,13 @@ function get_page_statuses( ) {
* Optional $args contents: * Optional $args contents:
* *
* label - A descriptive name for the post status marked for translation. Defaults to $post_status. * label - A descriptive name for the post status marked for translation. Defaults to $post_status.
* public - Whether posts of this status should be shown in the admin UI. Defaults to true. * public - Whether posts of this status should be shown in the front end of the site. Defaults to true.
* exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to true. * exclude_from_search - Whether to exclude posts with this post status from search results. Defaults to true.
* show_in_admin_all_list - Whether to include posts in the edit listing for their post type
* show_in_admin_status_list - Show in the list of statuses with post counts at the top of the edit
* listings, e.g. All (12) | Published (9) | My Custom Status (2) ...
*
* Arguments prefixed with an _underscore shouldn't be used by plugins and themes.
* *
* @package WordPress * @package WordPress
* @subpackage Post * @subpackage Post