<!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>[47157] trunk/src: Docs: Correct DocBlock formatting for `register_setting()`.</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/47157">47157</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/47157","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-02-01 21:59:14 +0000 (Sat, 01 Feb 2020)</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: Correct DocBlock formatting for `register_setting()`.
Document the full list of whitelisted option key names.
See <a href="https://core.trac.wordpress.org/ticket/48303">#48303</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesdeprecatedphp">trunk/src/wp-admin/includes/deprecated.php</a></li>
<li><a href="#trunksrcwpadminoptionsphp">trunk/src/wp-admin/options.php</a></li>
<li><a href="#trunksrcwpincludesnavmenuphp">trunk/src/wp-includes/nav-menu.php</a></li>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesdeprecatedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/deprecated.php 2020-02-01 21:36:44 UTC (rev 47156)
+++ trunk/src/wp-admin/includes/deprecated.php 2020-02-01 21:59:14 UTC (rev 47157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -160,7 +160,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @see register_setting()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Default whitelisted option key names include "general," "discussion," and "reading," among others.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default whitelisted option key names include 'general', 'discussion', 'media',
+ * 'reading', 'writing', 'misc', 'options', and 'privacy'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $option_name The name of an option to sanitize and save.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param callable $sanitize_callback A callback function that sanitizes the option's value.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpadminoptionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/options.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/options.php 2020-02-01 21:36:44 UTC (rev 47156)
+++ trunk/src/wp-admin/options.php 2020-02-01 21:59:14 UTC (rev 47157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,11 +196,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the options white list.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the options whitelist.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $whitelist_options White list options.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $whitelist_options Whitelist options.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $whitelist_options = apply_filters( 'whitelist_options', $whitelist_options );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesnavmenuphp"></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/nav-menu.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/nav-menu.php 2020-02-01 21:36:44 UTC (rev 47156)
+++ trunk/src/wp-includes/nav-menu.php 2020-02-01 21:59:14 UTC (rev 47157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -787,13 +787,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * - db_id: The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist).
</span><span class="cx" style="display: block; padding: 0 10px"> * - description: The description of this menu item.
</span><span class="cx" style="display: block; padding: 0 10px"> * - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - object: The type of object originally represented, such as "category," "post", or "attachment."
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - object: The type of object originally represented, such as 'category', 'post', or 'attachment'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * - object_id: The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
</span><span class="cx" style="display: block; padding: 0 10px"> * - post_parent: The DB ID of the original object's parent object, if any (0 otherwise).
</span><span class="cx" style="display: block; padding: 0 10px"> * - post_title: A "no title" label if menu item represents a post that lacks a title.
</span><span class="cx" style="display: block; padding: 0 10px"> * - target: The target attribute of the link element for this menu item.
</span><span class="cx" style="display: block; padding: 0 10px"> * - title: The title of this menu item.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * - type: The family of objects originally represented, such as "post_type" or "taxonomy."
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * - type: The family of objects originally represented, such as 'post_type' or 'taxonomy'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * - type_label: The singular label used to describe this type of menu item.
</span><span class="cx" style="display: block; padding: 0 10px"> * - url: The URL to which this menu item points.
</span><span class="cx" style="display: block; padding: 0 10px"> * - xfn: The XFN relationship expressed in the link of this menu item.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -982,8 +982,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $object_id The ID of the original object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $object_type The type of object, such as "taxonomy" or "post_type."
- * @param string $taxonomy If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $object_type The type of object, such as 'taxonomy' or 'post_type'.
+ * @param string $taxonomy If $object_type is 'taxonomy', $taxonomy is the name of the tax
+ * that $object_id belongs to.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int[] The array of menu item IDs; empty array if none;
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) {
</span></span></pre></div>
<a id="trunksrcwpincludesoptionphp"></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/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2020-02-01 21:36:44 UTC (rev 47156)
+++ trunk/src/wp-includes/option.php 2020-02-01 21:59:14 UTC (rev 47157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2098,7 +2098,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_registered_settings
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Default whitelisted option key names include "general," "discussion," and "reading," among others.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Default whitelisted option key names include 'general', 'discussion', 'media',
+ * 'reading', 'writing', 'misc', 'options', and 'privacy'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $option_name The name of an option to sanitize and save.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Data used to describe the setting when registered.
</span></span></pre>
</div>
</div>
</body>
</html>