Changeset 30778

Timestamp:

12/07/2014 08:12:50 PM (10 years ago)

Author:

DrewAPicture

Message:

Flesh out and fix formatting in the DocBlock for wp_register_widget_control().

Includes:

• Added todos for documenting $options in the hash notation style
• Backtick-escaping and general formatting

See #30315.

File:

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

trunk/src/wp-includes/widgets.php

@@ -993 +993 @@
  * multi-widgets (widgets which allow multiple instances such as the text
  * widget), an id_base must be provided. The widget id will end up looking like
- * {$id_base}-{$unique_number}.
+ * `{$id_base}-{$unique_number}`.
  *
  * @since 2.2.0
  *
- * @param int|string $id Sidebar ID.
- * @param string $name Sidebar display name.
- * @param callback $control_callback Run when sidebar is displayed.
- * @param array|string $options Optional. Widget options. See above long description.
- */
-function wp_register_widget_control($id, $name, $control_callback, $options = array()) {
+ * @todo Document `$options` as a hash notation, re: WP_Widget::__construct() cross-reference.
+ * @todo `$params` parameter?
+ *
+ * @param int|string   $id               Sidebar ID.
+ * @param string       $name             Sidebar display name.
+ * @param callback     $control_callback Run when sidebar is displayed.
+ * @param array|string $options          Optional. Widget options. See description above. Default empty array.
+ */
+function wp_register_widget_control( $id, $name, $control_callback, $options = array() ) {
     global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;