<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[20734] trunk/wp-includes/post.php: phpdoc updates for register_post_type().</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/20734">20734</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2012-05-07 16:25:06 +0000 (Mon, 07 May 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>phpdoc updates for register_post_type(). Props jeremyfelt. fixes <a href="http://core.trac.wordpress.org/ticket/20622">#20622</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludespostphp">trunk/wp-includes/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludespostphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/post.php (20733 => 20734)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/post.php 2012-05-07 16:16:17 UTC (rev 20733)
+++ trunk/wp-includes/post.php 2012-05-07 16:25:06 UTC (rev 20734)
</span><span class="lines">@@ -870,52 +870,80 @@
</span><span class="cx"> * Optional $args contents:
</span><span class="cx"> *
</span><span class="cx"> * - label - Name of the post type shown in the menu. Usually plural. If not set, labels['name'] will be used.
</span><ins>+ * - labels - An array of labels for this post type.
+ * * If not set, post labels are inherited for non-hierarchical types and page labels for hierarchical ones.
+ * * You can see accepted values in {@link get_post_type_labels()}.
</ins><span class="cx"> * - description - A short descriptive summary of what the post type is. Defaults to blank.
</span><del>- * - public - Whether posts of this type should be shown in the admin UI. Defaults to false.
- * - exclude_from_search - Whether to exclude posts with this post type from search results.
- * Defaults to true if the type is not public, false if the type is public.
- * - publicly_queryable - Whether post_type queries can be performed from the front page.
- * Defaults to whatever public is set as.
- * - show_ui - Whether to generate a default UI for managing this post type. Defaults to true
- * if the type is public, false if the type is not public.
- * - show_in_menu - Where to show the post type in the admin menu. True for a top level menu,
- * false for no menu, or can be a top level page like 'tools.php' or 'edit.php?post_type=page'.
- * show_ui must be true.
- * - menu_position - The position in the menu order the post type should appear. Defaults to the bottom.
</del><ins>+ * - public - Whether a post type is intended for use publicly either via the admin interface or by front-end users.
+ * * Defaults to false.
+ * * While the default settings of exclude_from_search, publicly_queryable, show_ui, and show_in_nav_menus are
+ * inherited from public, each does not rely on this relationship and controls a very specific intention.
+ * - exclude_from_search - Whether to exclude posts with this post type from front end search results.
+ * * If not set, the the opposite of public's current value is used.
+ * - publicly_queryable - Whether queries can be performed on the front end for the post type as part of parse_request().
+ * * ?post_type={post_type_key}
+ * * ?{post_type_key}={single_post_slug}
+ * * ?{post_type_query_var}={single_post_slug}
+ * * If not set, the default is inherited from public.
+ * - show_ui - Whether to generate a default UI for managing this post type in the admin.
+ * * If not set, the default is inherited from public.
+ * - show_in_nav_menus - Makes this post type available for selection in navigation menus.
+ * * If not set, the default is inherited from public.
+ * - show_in_menu - Where to show the post type in the admin menu.
+ * * If true, the post type is shown in its own top level menu.
+ * * If false, no menu is shown
+ * * If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type will
+ * be placed as a sub menu of that.
+ * * show_ui must be true.
+ * * If not set, the default is inherited from show_ui
+ * - show_in_admin_bar - Makes this post type available via the admin bar.
+ * * If not set, the default is inherited from show_in_menu
+ * - menu_position - The position in the menu order the post type should appear.
+ * * show_in_menu must be true
+ * * Defaults to null, which places it at the bottom of its area.
</ins><span class="cx"> * - menu_icon - The url to the icon to be used for this menu. Defaults to use the posts icon.
</span><span class="cx"> * - capability_type - The string to use to build the read, edit, and delete capabilities. Defaults to 'post'.
</span><del>- * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the
- * capabilities, e.g. array('story', 'stories').
- * - capabilities - Array of capabilities for this post type. By default the capability_type is used
- * as a base to construct capabilities. You can see accepted values in {@link get_post_type_capabilities()}.
</del><ins>+ * * May be passed as an array to allow for alternative plurals when using this argument as a base to construct the
+ * capabilities, e.g. array('story', 'stories').
+ * - capabilities - Array of capabilities for this post type.
+ * * By default the capability_type is used as a base to construct capabilities.
+ * * You can see accepted values in {@link get_post_type_capabilities()}.
</ins><span class="cx"> * - map_meta_cap - Whether to use the internal default meta capability handling. Defaults to false.
</span><del>- * - hierarchical - Whether the post type is hierarchical. Defaults to false.
- * - supports - An alias for calling add_post_type_support() directly. See {@link add_post_type_support()}
- * for documentation. Defaults to none.
</del><ins>+ * - hierarchical - Whether the post type is hierarchical (e.g. page). Defaults to false.
+ * - supports - An alias for calling add_post_type_support() directly. Defaults to title and editor.
+ * * See {@link add_post_type_support()} for documentation.
</ins><span class="cx"> * - register_meta_box_cb - Provide a callback function that will be called when setting up the
</span><span class="cx"> * meta boxes for the edit form. Do remove_meta_box() and add_meta_box() calls in the callback.
</span><span class="cx"> * - taxonomies - An array of taxonomy identifiers that will be registered for the post type.
</span><del>- * Default is no taxonomies. Taxonomies can be registered later with register_taxonomy() or
- * register_taxonomy_for_object_type().
- * - labels - An array of labels for this post type. By default post labels are used for non-hierarchical
- * types and page labels for hierarchical ones. You can see accepted values in {@link get_post_type_labels()}.
- * - has_archive - True to enable post type archives. Will generate the proper rewrite rules if rewrite is enabled.
- * - rewrite - false to prevent rewrite. Defaults to true. Use array('slug'=>$slug) to customize permastruct;
- * default will use $post_type as slug. Other options include 'with_front', 'feeds', 'pages', and 'ep_mask'.
- * - query_var - false to prevent queries, or string to value of the query var to use for this post type
- * - can_export - true allows this post type to be exported.
- * - show_in_nav_menus - true makes this post type available for selection in navigation menus.
</del><ins>+ * * Default is no taxonomies.
+ * * Taxonomies can be registered later with register_taxonomy() or register_taxonomy_for_object_type().
+ * - has_archive - True to enable post type archives. Default is false.
+ * * Will generate the proper rewrite rules if rewrite is enabled.
+ * - rewrite - Triggers the handling of rewrites for this post type. Defaults to true, using $post_type as slug.
+ * * To prevent rewrite, set to false.
+ * * To specify rewrite rules, an array can be passed with any of these keys
+ * * 'slug' => string Customize the permastruct slug. Defaults to $post_type key
+ * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
+ * * 'feeds' => bool Should a feed permastruct be built for this post type. Inherits default from has_archive.
+ * * 'pages' => bool Should the permastruct provide for pagination. Defaults to true.
+ * * 'ep_mask' => const Assign an endpoint mask.
+ * * If not specified and permalink_epmask is set, inherits from permalink_epmask.
+ * * If not specified and permalink_epmask is not set, defaults to EP_PERMALINK
+ * - query_var - Sets the query_var key for this post type. Defaults to $post_type key
+ * * If false, a post type cannot be loaded at ?{query_var}={post_slug}
+ * * If specified as a string, the query ?{query_var_string}={post_slug} will be valid.
+ * - can_export - Allows this post type to be exported. Defaults to true.
</ins><span class="cx"> * - _builtin - true if this post type is a native or "built-in" post_type. THIS IS FOR INTERNAL USE ONLY!
</span><span class="cx"> * - _edit_link - URL segement to use for edit link of this post type. THIS IS FOR INTERNAL USE ONLY!
</span><span class="cx"> *
</span><span class="cx"> * @since 2.9.0
</span><span class="cx"> * @uses $wp_post_types Inserts new post type object into the list
</span><span class="cx"> *
</span><del>- * @param string $post_type Name of the post type.
- * @param array|string $args See above description.
</del><ins>+ * @param string $post_type Post type key, must not exceed 20 characters
+ * @param array|string $args See optional args description above.
</ins><span class="cx"> * @return object|WP_Error the registered post type object, or an error object
</span><span class="cx"> */
</span><del>-function register_post_type($post_type, $args = array()) {
</del><ins>+function register_post_type( $post_type, $args = array() ) {
</ins><span class="cx"> global $wp_post_types, $wp_rewrite, $wp;
</span><span class="cx">
</span><span class="cx"> if ( !is_array($wp_post_types) )
</span></span></pre>
</div>
</div>
</body>
</html>