Docs: Add missing description for wp_convert_widget_settings() parameters.

Props stevenlinx.
Fixes #50738.

git-svn-id: https://develop.svn.wordpress.org/trunk@48580 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-23 13:48:37 +00:00
parent a3427e3bb6
commit 6c17894e5e
2 changed files with 8 additions and 7 deletions

View File

@ -151,7 +151,7 @@ class WP_Widget {
*
* @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.
* @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for
@ -181,7 +181,7 @@ class WP_Widget {
*
* @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.
* @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for

View File

@ -1046,21 +1046,22 @@ function wp_get_widget_defaults() {
}
/**
* Convert the widget settings from single to multi-widget format.
* Converts the widget settings from single to multi-widget format.
*
* @since 2.8.0
*
* @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 ) {
// This test may need expanding.
$single = false;
$changed = false;
if ( empty( $settings ) ) {
$single = true;
} else {