<!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>[47369] trunk/src/wp-includes/user.php: Docs: In `wp_insert_user()`, correct `@type` for `rich_editing`, `syntax_highlighting`, `comment_shortcuts`, and `show_admin_bar_front` arguments.</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/47369">47369</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/47369","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-25 18:18:26 +0000 (Tue, 25 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: In `wp_insert_user()`, correct `@type` for `rich_editing`, `syntax_highlighting`, `comment_shortcuts`, and `show_admin_bar_front` arguments.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/47368">[47368]</a>.
See <a href="https://core.trac.wordpress.org/ticket/49087">#49087</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2020-02-25 18:15:00 UTC (rev 47368)
+++ trunk/src/wp-includes/user.php 2020-02-25 18:18:26 UTC (rev 47369)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1484,44 +1484,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|object|WP_User $userdata {
</span><span class="cx" style="display: block; padding: 0 10px"> * An array, object, or WP_User object of user data arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type int $ID User ID. If supplied, the user will be updated.
- * @type string $user_pass The plain-text user password.
- * @type string $user_login The user's login username.
- * @type string $user_nicename The URL-friendly user name.
- * @type string $user_url The user URL.
- * @type string $user_email The user email address.
- * @type string $display_name The user's display name.
- * Default is the user's username.
- * @type string $nickname The user's nickname.
- * Default is the user's username.
- * @type string $first_name The user's first name. For new users, will be used
- * to build the first part of the user's display name
- * if `$display_name` is not specified.
- * @type string $last_name The user's last name. For new users, will be used
- * to build the second part of the user's display name
- * if `$display_name` is not specified.
- * @type string $description The user's biographical description.
- * @type string|bool $rich_editing Whether to enable the rich-editor for the user.
- * Accepts 'true' or 'false' as a string literal,
- * not boolean. Default 'true'.
- * @type string|bool $syntax_highlighting Whether to enable the rich code editor for the user.
- * Accepts 'true' or 'false' as a string literal,
- * not boolean. Default 'true'.
- * @type string|bool $comment_shortcuts Whether to enable comment moderation keyboard
- * shortcuts for the user. Accepts 'true' or 'false'
- * as a string literal, not boolean. Default 'false'.
- * @type string $admin_color Admin color scheme for the user. Default 'fresh'.
- * @type bool $use_ssl Whether the user should always access the admin over
- * https. Default false.
- * @type string $user_registered Date the user registered. Format is 'Y-m-d H:i:s'.
- * @type string $user_activation_key Password reset key. Default empty.
- * @type bool $spam Multisite only. Whether the user is marked as spam.
- * Default false.
- * @type string|bool $show_admin_bar_front Whether to display the Admin Bar for the user
- * on the site's front end. Accepts 'true' or 'false'
- * as a string literal, not boolean. Default 'true'.
- * @type string $role User's role.
- * @type string $locale User's locale. Default empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int $ID User ID. If supplied, the user will be updated.
+ * @type string $user_pass The plain-text user password.
+ * @type string $user_login The user's login username.
+ * @type string $user_nicename The URL-friendly user name.
+ * @type string $user_url The user URL.
+ * @type string $user_email The user email address.
+ * @type string $display_name The user's display name.
+ * Default is the user's username.
+ * @type string $nickname The user's nickname.
+ * Default is the user's username.
+ * @type string $first_name The user's first name. For new users, will be used
+ * to build the first part of the user's display name
+ * if `$display_name` is not specified.
+ * @type string $last_name The user's last name. For new users, will be used
+ * to build the second part of the user's display name
+ * if `$display_name` is not specified.
+ * @type string $description The user's biographical description.
+ * @type string $rich_editing Whether to enable the rich-editor for the user.
+ * Accepts 'true' or 'false' as a string literal,
+ * not boolean. Default 'true'.
+ * @type string $syntax_highlighting Whether to enable the rich code editor for the user.
+ * Accepts 'true' or 'false' as a string literal,
+ * not boolean. Default 'true'.
+ * @type string $comment_shortcuts Whether to enable comment moderation keyboard
+ * shortcuts for the user. Accepts 'true' or 'false'
+ * as a string literal, not boolean. Default 'false'.
+ * @type string $admin_color Admin color scheme for the user. Default 'fresh'.
+ * @type bool $use_ssl Whether the user should always access the admin over
+ * https. Default false.
+ * @type string $user_registered Date the user registered. Format is 'Y-m-d H:i:s'.
+ * @type string $user_activation_key Password reset key. Default empty.
+ * @type bool $spam Multisite only. Whether the user is marked as spam.
+ * Default false.
+ * @type string $show_admin_bar_front Whether to display the Admin Bar for the user
+ * on the site's front end. Accepts 'true' or 'false'
+ * as a string literal, not boolean. Default 'true'.
+ * @type string $role User's role.
+ * @type string $locale User's locale. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int|WP_Error The newly created user's ID or a WP_Error object if the user could not
</span><span class="cx" style="display: block; padding: 0 10px"> * be created.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1830,13 +1830,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $first_name The user's first name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $last_name The user's last name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $description The user's description.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type bool $rich_editing Whether to enable the rich-editor for the user. Default 'true'.
- * @type bool $syntax_highlighting Whether to enable the rich code editor for the user. Default 'true'.
- * @type bool $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default 'false'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $rich_editing Whether to enable the rich-editor for the user. Default 'true'.
+ * @type string $syntax_highlighting Whether to enable the rich code editor for the user. Default 'true'.
+ * @type string $comment_shortcuts Whether to enable keyboard shortcuts for the user. Default 'false'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $admin_color The color scheme for a user's admin screen. Default 'fresh'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL is
- * not forced.
- * @type bool $show_admin_bar_front Whether to show the admin bar on the front end for the user.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int|bool $use_ssl Whether to force SSL on the user's admin area. 0|false if SSL
+ * is not forced.
+ * @type string $show_admin_bar_front Whether to show the admin bar on the front end for the user.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default 'true'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $locale User's locale. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span></span></pre>
</div>
</div>
</body>
</html>