<!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>[52362] trunk/src: Docs: Capitalize "ID", when referring to a widget ID or sidebar ID, in a more consistent way.</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/52362">52362</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/52362","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>2021-12-13 10:19:21 +0000 (Mon, 13 Dec 2021)</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: Capitalize "ID", when referring to a widget ID or sidebar ID, in a more consistent way.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/48104">[48104]</a>, <a href="https://core.trac.wordpress.org/changeset/52357">[52357]</a>, <a href="https://core.trac.wordpress.org/changeset/52361">[52361]</a>.
See <a href="https://core.trac.wordpress.org/ticket/53399">#53399</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludeswidgetsphp">trunk/src/wp-admin/includes/widgets.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestsidebarscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestwidgetscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php</a></li>
<li><a href="#trunksrcwpincludeswidgetsphp">trunk/src/wp-includes/widgets.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludeswidgetsphp"></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/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/widgets.php 2021-12-12 18:59:55 UTC (rev 52361)
+++ trunk/src/wp-admin/includes/widgets.php 2021-12-13 10:19:21 UTC (rev 52362)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -226,7 +226,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $sidebar_args['_display'] ) && 'template' === $sidebar_args['_display'] && $widget_number ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // number == -1 implies a template where id numbers are replaced by a generic '__i__'.
</span><span class="cx" style="display: block; padding: 0 10px"> $control['params'][0]['number'] = -1;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // With id_base widget id's are constructed like {$id_base}-{$id_number}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // With id_base widget ID's are constructed like {$id_base}-{$id_number}.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $control['id_base'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $id_format = $control['id_base'] . '-__i__';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestsidebarscontrollerphp"></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/rest-api/endpoints/class-wp-rest-sidebars-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php 2021-12-12 18:59:55 UTC (rev 52361)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php 2021-12-13 10:19:21 UTC (rev 52362)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -219,12 +219,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $sidebars as $sidebar_id => $widgets ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $widgets as $i => $widget_id ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // This automatically removes the passed widget ids from any other sidebars in use.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This automatically removes the passed widget IDs from any other sidebars in use.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $sidebar_id !== $request['id'] && in_array( $widget_id, $request['widgets'], true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $sidebars[ $sidebar_id ][ $i ] );
</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">- // This automatically removes omitted widget ids to the inactive sidebar.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This automatically removes omitted widget IDs to the inactive sidebar.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $sidebar_id === $request['id'] && ! in_array( $widget_id, $request['widgets'], true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars['wp_inactive_widgets'][] = $widget_id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestwidgetscontrollerphp"></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/rest-api/endpoints/class-wp-rest-widgets-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php 2021-12-12 18:59:55 UTC (rev 52361)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php 2021-12-13 10:19:21 UTC (rev 52362)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -188,7 +188,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.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 string $sidebar_id The sidebar id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $sidebar_id The sidebar ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the sidebar can be read.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_read_sidebar_permission( $sidebar_id ) {
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsphp"></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/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets.php 2021-12-12 18:59:55 UTC (rev 52361)
+++ trunk/src/wp-includes/widgets.php 2021-12-13 10:19:21 UTC (rev 52362)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -519,7 +519,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $width Width of the fully expanded control form (but try hard to use the default width).
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 250.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int|string $id_base Required for multi-widgets, i.e widgets that allow multiple instances such as the
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * text widget. The widget id will end up looking like `{$id_base}-{$unique_number}`.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * text widget. The widget ID will end up looking like `{$id_base}-{$unique_number}`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed ...$params Optional additional parameters to pass to the callback function when it's called.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1916,8 +1916,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.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 string $widget_id The widget id to look for.
- * @return string|null The found sidebar's id, or null if it was not found.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $widget_id The widget ID to look for.
+ * @return string|null The found sidebar's ID, or null if it was not found.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_find_widgets_sidebar( $widget_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( wp_get_sidebars_widgets() as $sidebar_id => $widget_ids ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1936,8 +1936,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.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 string $widget_id The widget id to assign.
- * @param string $sidebar_id The sidebar id to assign to. If empty, the widget won't be added to any sidebar.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $widget_id The widget ID to assign.
+ * @param string $sidebar_id The sidebar ID to assign to. If empty, the widget won't be added to any sidebar.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_assign_widget_to_sidebar( $widget_id, $sidebar_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars = wp_get_sidebars_widgets();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1946,7 +1946,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $widgets as $i => $maybe_widget_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $widget_id === $maybe_widget_id && $sidebar_id !== $maybe_sidebar_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $sidebars[ $maybe_sidebar_id ][ $i ] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We could technically break 2 here, but continue looping in case the id is duplicated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We could technically break 2 here, but continue looping in case the ID is duplicated.
</ins><span class="cx" style="display: block; padding: 0 10px"> continue 2;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>