Docs: Add missing description for `wp_convert_widget_settings()` parameters.

Props stevenlinx.
Fixes #50738.
Built from https://develop.svn.wordpress.org/trunk@48580


git-svn-id: http://core.svn.wordpress.org/trunk@48342 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2020-07-23 13:50:02 +00:00
parent 12747ac7b7
commit 91bcefd456
3 changed files with 9 additions and 8 deletions

View File

@ -151,7 +151,7 @@ class WP_Widget {
* *
* @since 2.8.0 * @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. * 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 string $name Name for the widget displayed on the configuration page.
* @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for * @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for
@ -181,7 +181,7 @@ class WP_Widget {
* *
* @see WP_Widget::__construct() * @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. * 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 string $name Name for the widget displayed on the configuration page.
* @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for * @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.5-beta3-48579'; $wp_version = '5.5-beta3-48580';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

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 * @since 2.8.0
* *
* @global array $_wp_sidebars_widgets * @global array $_wp_sidebars_widgets
* *
* @param string $base_name * @param string $base_name Root ID for all widgets of this type.
* @param string $option_name * @param string $option_name Option name for this widget type.
* @param array $settings * @param array $settings The array of widget instance settings.
* @return array * @return array The array of widget settings converted to multi-widget format.
*/ */
function wp_convert_widget_settings( $base_name, $option_name, $settings ) { function wp_convert_widget_settings( $base_name, $option_name, $settings ) {
// This test may need expanding. // This test may need expanding.
$single = false; $single = false;
$changed = false; $changed = false;
if ( empty( $settings ) ) { if ( empty( $settings ) ) {
$single = true; $single = true;
} else { } else {