Changeset 52362 for trunk/src/wp-includes/widgets.php

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.

File:

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

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;
             }