Ticket #28298: 28298.the_widget.diff

src/wp-includes/widgets.php

@@ -1442 +1442 @@
  *
  * @since 2.8.0
  *
- * @param string $widget the widget's PHP class name (see default-widgets.php)
- * @param array $instance the widget's instance settings
- * @param array $args the widget's sidebar args
- * @return void
- **/
+ * @param string $widget   The widget's PHP class name (see default-widgets.php).
+ * @param array  $instance Optional. The widget's instance settings.
+ * @param array  $args {
+ *     Optional. Array of arguments to configure the display of the widget.
+ *
+ *     @type string $before_widget HTML content that will be prepended to the widget's HTML output.
+ *                                 Default '<div class="widget %s">', where '%s' is the widget's class name.
+ *     @type string $after_widget  HTML content that will be appended to the widget's HTML output.
+ *                                 Default '</div>'.
+ *     @type string $before_title  HTML content that will be prepended to the widget's title when displayed.
+ *                                 Default '<h2 class="widgettitle">'.
+ *     @type string $after_title   HTML content that will be appended to the widget's title when displayed.
+ *                                 Default '</h2>'.
+ * }
+ */
 function the_widget($widget, $instance = array(), $args = array()) {
         global $wp_widget_factory;