Changeset 30665

Timestamp:

11/30/2014 10:04:23 PM (10 years ago)

Author:

wonderboymusic

Message:

Improve the @param docs for src/wp-includes/widgets.php.

See #30224.

File:

• trunk/src/wp-includes/widgets.php (modified) (9 diffs)

trunk/src/wp-includes/widgets.php

@@ -110 +110 @@
     /**
      * PHP4 constructor
+     * 
+     * @param string $id_base
+     * @param string $name
+     * @param array  $widget_options
+     * @param array  $control_options
      */
     public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
@@ -273 +278 @@
      * Do NOT over-ride this function.
      *
-     * @param mixed $deprecated Not used.
+     * @param int $deprecated Not used.
      */
     public function update_callback( $deprecated = 1 ) {
@@ -848 +853 @@
  * @since 2.9.0
  *
- * @param int|string $id sidebar ID.
+ * @param string $id sidebar ID.
  * @return string Sidebar description, if available. Null on failure to retrieve description.
  */
@@ -899 +904 @@
  * @param callback $control_callback Run when sidebar is displayed.
  * @param array|string $options Optional. Widget options. See above long description.
- * @param mixed $params,... Optional. Additional parameters to add to widget.
  */
 function wp_register_widget_control($id, $name, $control_callback, $options = array()) {
@@ -948 +952 @@
 }
 
+/**
+ *
+ * @global array $wp_registered_widget_updates
+ * @param string   $id_base
+ * @param callable $update_callback
+ * @param array    $options
+ */
 function _register_widget_update_callback($id_base, $update_callback, $options = array()) {
     global $wp_registered_widget_updates;
@@ -966 +977 @@
 }
 
+/**
+ *
+ * @global array $wp_registered_widget_controls
+ * @param int|string $id
+ * @param string     $name
+ * @param callable   $form_callback
+ * @param array      $options
+ * @return null
+ */
 function _register_widget_form_callback($id, $name, $form_callback, $options = array()) {
     global $wp_registered_widget_controls;
@@ -1250 +1270 @@
  * @since 2.8.0
  *
- * @param mixed $index Sidebar name, id or number to check.
+ * @param string|int $index Sidebar name, id or number to check.
  * @return bool true if the sidebar is in use, false otherwise.
  */
@@ -1353 +1373 @@
  * @since 2.8.0
  *
+ * @param string $base_name
+ * @param string $option_name
+ * @param array  $settings
  * @return array
  */
@@ -1471 +1494 @@
  * @since 2.8.0
  *
- * @param mixed $theme_changed Whether the theme was changed as a boolean. A value
- *                             of 'customize' defers updates for the Customizer.
+ * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
+ *                                   of 'customize' defers updates for the Customizer.
  * @return array
  */