Changeset 36868

Timestamp:

03/06/2016 12:07:34 PM (9 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add wp_add_dashboard_widget() parameter descriptions.

Props meitar for initial patch.
Fixes #36092.

File:

• trunk/src/wp-admin/includes/dashboard.php (modified) (1 diff)

trunk/src/wp-admin/includes/dashboard.php

@@ -131 +131 @@
 
 /**
+ * Adds a new dashboard widget.
  *
  * @global array   $wp_dashboard_control_callbacks
  *
- * @param string   $widget_id
- * @param string   $widget_name
- * @param callable $callback
- * @param callable $control_callback
- * @param array    $callback_args
+ * @param string   $widget_id        Widget ID  (used in the 'id' attribute for the widget).
+ * @param string   $widget_name      Title of the widget.
+ * @param callable $callback         Function that fills the widget with the desired content.
+ *                                   The function should echo its output.
+ * @param callable $control_callback Optional. Function that outputs controls for the widget. Default null.
+ * @param array    $callback_args    Optional. Data that should be set as the $args property of the widget array
+ *                                   (which is the second parameter passed to your callback). Default null.
  */
 function wp_add_dashboard_widget( $widget_id, $widget_name, $callback, $control_callback = null, $callback_args = null ) {