Changeset 47122 for trunk/src/wp-admin/includes/widgets.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-admin/includes/widgets.php (modified) (4 diffs)

trunk/src/wp-admin/includes/widgets.php

@@ -23 +23 @@
 
     foreach ( $sort as $widget ) {
-        if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget
+        if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget.
             continue;
         }
@@ -143 +143 @@
     $params[0]['before_widget'] = "<div id='widget-{$i}_{$id}' class='widget'$hidden>";
     $params[0]['after_widget']  = '</div>';
-    $params[0]['before_title']  = '%BEG_OF_TITLE%'; // deprecated
-    $params[0]['after_title']   = '%END_OF_TITLE%'; // deprecated
+    $params[0]['before_title']  = '%BEG_OF_TITLE%'; // Deprecated.
+    $params[0]['after_title']   = '%END_OF_TITLE%'; // Deprecated.
 
     if ( is_callable( $wp_registered_widgets[ $widget_id ]['callback'] ) ) {
@@ -193 +193 @@
     $widget_id  = $sidebar_args['widget_id'];
     $sidebar_id = isset( $sidebar_args['id'] ) ? $sidebar_args['id'] : false;
-    $key        = $sidebar_id ? array_search( $widget_id, $sidebars_widgets[ $sidebar_id ] ) : '-1'; // position of widget in sidebar
+    $key        = $sidebar_id ? array_search( $widget_id, $sidebars_widgets[ $sidebar_id ] ) : '-1'; // Position of widget in sidebar.
     $control    = isset( $wp_registered_widget_controls[ $widget_id ] ) ? $wp_registered_widget_controls[ $widget_id ] : array();
     $widget     = $wp_registered_widgets[ $widget_id ];
@@ -227 +227 @@
      */
     if ( isset( $sidebar_args['_display'] ) && 'template' == $sidebar_args['_display'] && $widget_number ) {
-        // number == -1 implies a template where id numbers are replaced by a generic '__i__'
+        // number == -1 implies a template where id numbers are replaced by a generic '__i__'.
         $control['params'][0]['number'] = -1;
         // With id_base widget id's are constructed like {$id_base}-{$id_number}.