<!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>[46246] trunk/src/wp-includes/post.php: Docs: Improve documentation for the `supports` argument in `register_post_type()`/`add_post_type_support()`.</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 { white-space: pre-line; 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 { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46246">46246</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46246","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-23 16:07:23 +0000 (Mon, 23 Sep 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve documentation for the `supports` argument in `register_post_type()`/`add_post_type_support()`.
Follow up of <a href="https://core.trac.wordpress.org/changeset/46160">[46160]</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/40413">#40413</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2019-09-23 16:02:38 UTC (rev 46245)
+++ trunk/src/wp-includes/post.php 2019-09-23 16:07:23 UTC (rev 46246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1272,7 +1272,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0 Post type object returned is now an instance of `WP_Post_Type`.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0 Introduced `show_in_rest`, `rest_base` and `rest_controller_class`
</span><span class="cx" style="display: block; padding: 0 10px"> * arguments to register the post type in REST API.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.0 The `supports` argument will now accept an array of arguments for a feature.
+ * .
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_post_types List of post types.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_type Post type key. Must not exceed 20 characters and may
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1343,8 +1344,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 'page-attributes', 'thumbnail', 'custom-fields', and 'post-formats'.
</span><span class="cx" style="display: block; padding: 0 10px"> * Additionally, the 'revisions' feature dictates whether the post type
</span><span class="cx" style="display: block; padding: 0 10px"> * will store revisions, and the 'comments' feature dictates whether the
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * comments count will show on the edit screen. Defaults is an array
- * containing 'title' and 'editor'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * comments count will show on the edit screen. A feature can also be
+ * specified as an array of arguments to provide additional information
+ * about supporting that feature. Example: `array( 'my_feature', array(
+ * 'field' => 'value' ) )`. Default is an array containing 'title' and
+ * 'editor'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type callable $register_meta_box_cb Provide a callback function that sets up the meta boxes for the
</span><span class="cx" style="display: block; padding: 0 10px"> * edit form. Do remove_meta_box() and add_meta_box() calls in the
</span><span class="cx" style="display: block; padding: 0 10px"> * callback. Default null.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1801,6 +1805,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * store revisions, and the 'comments' feature dictates whether the comments
</span><span class="cx" style="display: block; padding: 0 10px"> * count will show on the edit screen.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A third, optional parameter can also be passed along with a feature to provide
+ * additional information about supporting that feature.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * Example usage:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * add_post_type_support( 'my_post_type', 'comments' );
</span></span></pre>
</div>
</div>
</body>
</html>