Correct the docblock for wp_list_widget_controls().

SergeyBiryukov · SergeyBiryukov · commit 8512ff08c07c · 2015-09-05T23:37:17.000Z
Props swissspidy. Fixes #33751. git-svn-id: https://develop.svn.wordpress.org/trunk@33930 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/includes/widgets.php b/src/wp-admin/includes/widgets.php
@@ -67,8 +67,8 @@ function _sort_name_callback( $a, $b ) {
  *
  * @since 2.5.0
  *
- * @param string $sidebar id slug of the sidebar
- * @param string optional $sidebar_name Include the HTML for the sidebar name
+ * @param string $sidebar      Sidebar ID.
+ * @param string $sidebar_name Optional. Sidebar name. Default empty.
  */
 function wp_list_widget_controls( $sidebar, $sidebar_name = '' ) {
 	add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' );

Original file line number	Diff line number	Diff line change
`@@ -67,8 +67,8 @@ function _sort_name_callback( $a, $b ) {`
`67`	`67`	`*`
`68`	`68`	`* @since 2.5.0`
`69`	`69`	`*`
`70`		`- * @param string $sidebar id slug of the sidebar`
`71`		`- * @param string optional $sidebar_name Include the HTML for the sidebar name`
	`70`	`+ * @param string $sidebar Sidebar ID.`
	`71`	`+ * @param string $sidebar_name Optional. Sidebar name. Default empty.`
`72`	`72`	`*/`
`73`	`73`	`function wp_list_widget_controls( $sidebar, $sidebar_name = '' ) {`
`74`	`74`	`add_filter( 'dynamic_sidebar_params', 'wp_list_widget_controls_dynamic_sidebar' );`