Changeset 52362

Timestamp:

12/13/2021 10:19:21 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Capitalize "ID", when referring to a widget ID or sidebar ID, in a more consistent way.

Follow-up to [48104], [52357], [52361].

See #53399.

Location:

trunk/src

Files:

• wp-admin/includes/widgets.php (modified) (1 diff)
• wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php (modified) (1 diff)
• wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php (modified) (1 diff)
• wp-includes/widgets.php (modified) (4 diffs)

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

@@ -227 +227 @@
         // 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}.
+        // With id_base widget ID's are constructed like {$id_base}-{$id_number}.
         if ( isset( $control['id_base'] ) ) {
             $id_format = $control['id_base'] . '-__i__';

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-sidebars-controller.php

@@ -220 +220 @@
             foreach ( $sidebars as $sidebar_id => $widgets ) {
                 foreach ( $widgets as $i => $widget_id ) {
-                    // This automatically removes the passed widget ids from any other sidebars in use.
+                    // This automatically removes the passed widget IDs from any other sidebars in use.
                     if ( $sidebar_id !== $request['id'] && in_array( $widget_id, $request['widgets'], true ) ) {
                         unset( $sidebars[ $sidebar_id ][ $i ] );
                     }
 
-                    // This automatically removes omitted widget ids to the inactive sidebar.
+                    // This automatically removes omitted widget IDs to the inactive sidebar.
                     if ( $sidebar_id === $request['id'] && ! in_array( $widget_id, $request['widgets'], true ) ) {
                         $sidebars['wp_inactive_widgets'][] = $widget_id;

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-widgets-controller.php

@@ -189 +189 @@
      * @since 5.9.0
      *
-     * @param string $sidebar_id The sidebar id.
+     * @param string $sidebar_id The sidebar ID.
      * @return bool Whether the sidebar can be read.
      */

trunk/src/wp-includes/widgets.php

@@ -520 +520 @@
  *                               Default 250.
  *     @type int|string $id_base Required for multi-widgets, i.e widgets that allow multiple instances such as the
- *                               text widget. The widget id will end up looking like `{$id_base}-{$unique_number}`.
+ *                               text widget. The widget ID will end up looking like `{$id_base}-{$unique_number}`.
  * }
  * @param mixed      ...$params        Optional additional parameters to pass to the callback function when it's called.
@@ -1917 +1917 @@
  * @since 5.8.0
  *
- * @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.
+ * @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.
  */
 function wp_find_widgets_sidebar( $widget_id ) {
@@ -1937 +1937 @@
  * @since 5.8.0
  *
- * @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.
+ * @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.
  */
 function wp_assign_widget_to_sidebar( $widget_id, $sidebar_id ) {
@@ -1947 +1947 @@
             if ( $widget_id === $maybe_widget_id && $sidebar_id !== $maybe_sidebar_id ) {
                 unset( $sidebars[ $maybe_sidebar_id ][ $i ] );
-                // We could technically break 2 here, but continue looping in case the id is duplicated.
+                // We could technically break 2 here, but continue looping in case the ID is duplicated.
                 continue 2;
             }