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

Timestamp:

01/29/2020 12:43:23 AM (6 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-includes/class-wp-customize-widgets.php (modified) (10 diffs)

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -277 +277 @@
         $this->manager->set_post_value( 'old_sidebars_widgets_data', $this->old_sidebars_widgets ); // Override any value cached in changeset.
 
-        // retrieve_widgets() looks at the global $sidebars_widgets
+        // retrieve_widgets() looks at the global $sidebars_widgets.
         $sidebars_widgets = $this->old_sidebars_widgets;
         $sidebars_widgets = retrieve_widgets( 'customize' );
         add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
-        // reset global cache var used by wp_get_sidebars_widgets()
+        // Reset global cache var used by wp_get_sidebars_widgets().
         unset( $GLOBALS['_wp_sidebars_widgets'] );
     }
@@ -610 +610 @@
             $parsed['number']  = intval( $matches[2] );
         } else {
-            // likely an old single widget
+            // Likely an old single widget.
             $parsed['id_base'] = $widget_id;
         }
@@ -773 +773 @@
             'registeredSidebars'          => array_values( $wp_registered_sidebars ),
             'registeredWidgets'           => $wp_registered_widgets,
-            'availableWidgets'            => $available_widgets, // @todo Merge this with registered_widgets
+            'availableWidgets'            => $available_widgets, // @todo Merge this with registered_widgets.
             'l10n'                        => array(
                 'saveBtnLabel'     => __( 'Apply' ),
@@ -800 +800 @@
 
         foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
-            unset( $registered_widget['callback'] ); // may not be JSON-serializeable
+            unset( $registered_widget['callback'] ); // May not be JSON-serializeable.
         }
 
@@ -950 +950 @@
 
         global $wp_registered_widgets, $wp_registered_widget_controls;
-        require_once ABSPATH . 'wp-admin/includes/widgets.php'; // for next_widget_id_number()
+        require_once ABSPATH . 'wp-admin/includes/widgets.php'; // For next_widget_id_number().
 
         $sort = $wp_registered_widgets;
@@ -957 +957 @@
 
         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;
             }
@@ -969 +969 @@
 
             $available_widget = $widget;
-            unset( $available_widget['callback'] ); // not serializable to JSON
+            unset( $available_widget['callback'] ); // Not serializable to JSON.
 
             $args = array(
@@ -1191 +1191 @@
         );
         foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
-            unset( $registered_widget['callback'] ); // may not be JSON-serializeable
+            unset( $registered_widget['callback'] ); // May not be JSON-serializeable.
         }
 
@@ -1461 +1461 @@
         }
 
-        // Clean up any input vars that were manually added
+        // Clean up any input vars that were manually added.
         foreach ( $added_input_vars as $key ) {
             unset( $_POST[ $key ] );
@@ -1874 +1874 @@
 
     //
-    // Option Update Capturing
+    // Option Update Capturing.
     //