<!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>[61187] trunk/src/wp-admin/widgets-form.php: Coding Standards: Use more meaningful variable names in Classic Widgets screen.</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/61187">61187</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/61187","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>2025-11-09 23:01:32 +0000 (Sun, 09 Nov 2025)</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'>Coding Standards: Use more meaningful variable names in Classic Widgets screen.
Per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]:
> Don't abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting.
This commit includes renaming of the following variables:
* `$sbname` to `$sidebar_name`.
* `$sbvalue` to `$sidebar_data`.
* `$j` to `$widget_count`.
* `$i` to `$sidebar_index`.
* `$sb` to `$sidebar`.
* `$key` to `$sidebar_id`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/10912">[10912]</a>, <a href="https://core.trac.wordpress.org/changeset/11009">[11009]</a>, <a href="https://core.trac.wordpress.org/changeset/11427">[11427]</a>, <a href="https://core.trac.wordpress.org/changeset/26285">[26285]</a>, <a href="https://core.trac.wordpress.org/changeset/50997">[50997]</a>.
Props costdev, mukesh27.
See <a href="https://core.trac.wordpress.org/ticket/63168">#63168</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminwidgetsformphp">trunk/src/wp-admin/widgets-form.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminwidgetsformphp"></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/widgets-form.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/widgets-form.php 2025-11-08 13:46:21 UTC (rev 61186)
+++ trunk/src/wp-admin/widgets-form.php 2025-11-09 23:01:32 UTC (rev 61187)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,11 +187,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Remove old position.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $_POST['delete_widget'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $sidebars_widgets as $key => $sb ) {
- if ( is_array( $sb ) ) {
- $sidebars_widgets[ $key ] = array_diff( $sb, array( $widget_id ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $sidebars_widgets as $sidebar_id => $sidebar ) {
+ if ( is_array( $sidebar ) ) {
+ $sidebars_widgets[ $sidebar_id ] = array_diff( $sidebar, array( $widget_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> array_splice( $sidebars_widgets[ $sidebar_id ], $position, 0, $widget_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,11 +236,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Copy minimal info from an existing instance of this widget to a new instance.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $wp_registered_widget_controls as $control ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $_GET['base'] === $control['id_base'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $control_callback = $control['callback'];
- $multi_number = (int) $_GET['num'];
- $control['params'][0]['number'] = -1;
- $control['id'] = $control['id_base'] . '-' . $multi_number;
- $widget_id = $control['id'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $control_callback = $control['callback'];
+ $multi_number = (int) $_GET['num'];
+ $control['params'][0]['number'] = -1;
+ $control['id'] = $control['id_base'] . '-' . $multi_number;
+ $widget_id = $control['id'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_registered_widget_controls[ $control['id'] ] = $control;
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -299,31 +301,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="widget-position">
</span><span class="cx" style="display: block; padding: 0 10px"> <table class="widefat"><thead><tr><th><?php _e( 'Sidebar' ); ?></th><th><?php _e( 'Position' ); ?></th></tr></thead><tbody>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $wp_registered_sidebars as $sbname => $sbvalue ) {
- echo "\t\t<tr><td><label><input type='radio' name='sidebar' value='" . esc_attr( $sbname ) . "'" . checked( $sbname, $sidebar, false ) . " /> $sbvalue[name]</label></td><td>";
- if ( 'wp_inactive_widgets' === $sbname || str_starts_with( $sbname, 'orphaned_widgets' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $wp_registered_sidebars as $sidebar_name => $sidebar_data ) {
+ echo "\t\t<tr><td><label><input type='radio' name='sidebar' value='" . esc_attr( $sidebar_name ) . "'" .
+ checked( $sidebar_name, $sidebar, false ) . " /> $sidebar_data[name]</label></td><td>";
+
+ if ( 'wp_inactive_widgets' === $sidebar_name || str_starts_with( $sidebar_name, 'orphaned_widgets' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> echo ' ';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! isset( $sidebars_widgets[ $sbname ] ) || ! is_array( $sidebars_widgets[ $sbname ] ) ) {
- $j = 1;
- $sidebars_widgets[ $sbname ] = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $sidebars_widgets[ $sidebar_name ] ) || ! is_array( $sidebars_widgets[ $sidebar_name ] ) ) {
+ $widget_count = 1;
+
+ $sidebars_widgets[ $sidebar_name ] = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $j = count( $sidebars_widgets[ $sbname ] );
- if ( isset( $_GET['addnew'] ) || ! in_array( $widget_id, $sidebars_widgets[ $sbname ], true ) ) {
- ++$j;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $widget_count = count( $sidebars_widgets[ $sidebar_name ] );
+
+ if ( isset( $_GET['addnew'] ) || ! in_array( $widget_id, $sidebars_widgets[ $sidebar_name ], true ) ) {
+ ++$widget_count;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $selected = '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- echo "\t\t<select name='{$sbname}_position'>\n";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ echo "\t\t<select name='{$sidebar_name}_position'>\n";
</ins><span class="cx" style="display: block; padding: 0 10px"> echo "\t\t<option value=''>" . __( '— Select —' ) . "</option>\n";
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- for ( $i = 1; $i <= $j; $i++ ) {
- if ( in_array( $widget_id, $sidebars_widgets[ $sbname ], true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ for ( $i = 1; $i <= $widget_count; $i++ ) {
+ if ( in_array( $widget_id, $sidebars_widgets[ $sidebar_name ], true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $selected = selected( $i, $key + 1, false );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> echo "\t\t<option value='$i'$selected> $i </option>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> echo "\t\t</select>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> echo "</td></tr>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -512,7 +524,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$i = 0;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$sidebar_index = 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> $split = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $single_sidebar_class = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars_count = count( $theme_sidebars );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -535,11 +547,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wrap_class .= ' sidebar-' . $registered_sidebar['class'];
</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">- if ( $i > 0 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $sidebar_index > 0 ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wrap_class .= ' closed';
</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">- if ( $split && $i === $split ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $split && $sidebar_index === $split ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </div><div class="sidebars-column-2">
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -554,7 +566,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ++$i;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ++$sidebar_index;
</ins><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></span></pre>
</div>
</div>
</body>
</html>