Changeset 48580

Timestamp:

07/23/2020 01:48:37 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing description for wp_convert_widget_settings() parameters.

Props stevenlinx.
Fixes #50738.

Location:

trunk/src/wp-includes

Files:

• class-wp-widget.php (modified) (2 diffs)
• widgets.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-widget.php

@@ -152 +152 @@
      * @since 2.8.0
      *
-     * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty,
+     * @param string $id_base         Optional. Base ID for the widget, lowercase and unique. If left empty,
      *                                a portion of the widget's class name will be used. Has to be unique.
      * @param string $name            Name for the widget displayed on the configuration page.
@@ -182 +182 @@
      * @see WP_Widget::__construct()
      *
-     * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty,
+     * @param string $id_base         Optional. Base ID for the widget, lowercase and unique. If left empty,
      *                                a portion of the widget's class name will be used. Has to be unique.
      * @param string $name            Name for the widget displayed on the configuration page.

trunk/src/wp-includes/widgets.php

@@ -1047 +1047 @@
 
 /**
- * Convert the widget settings from single to multi-widget format.
+ * Converts the widget settings from single to multi-widget format.
  *
  * @since 2.8.0
@@ -1053 +1053 @@
  * @global array $_wp_sidebars_widgets
  *
- * @param string $base_name
- * @param string $option_name
- * @param array  $settings
- * @return array
+ * @param string $base_name   Root ID for all widgets of this type.
+ * @param string $option_name Option name for this widget type.
+ * @param array  $settings    The array of widget instance settings.
+ * @return array The array of widget settings converted to multi-widget format.
  */
 function wp_convert_widget_settings( $base_name, $option_name, $settings ) {
@@ -1062 +1062 @@
     $single  = false;
     $changed = false;
+
     if ( empty( $settings ) ) {
         $single = true;