Changeset 48473 for trunk/src/wp-includes/widgets.php

Timestamp:

07/14/2020 11:54:26 AM (6 years ago)

Author:

johnbillion

Message:

Docs: Correct and improve inline docs for parameters that accept a callback function.

See #49572

File:

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

trunk/src/wp-includes/widgets.php

@@ -788 +788 @@
                  *     An associative array of widget arguments.
                  *
-                 *     @type string $name                Name of the widget.
-                 *     @type string $id                  Widget ID.
-                 *     @type array|callable $callback    When the hook is fired on the front end, $callback is an array
-                 *                                       containing the widget object. Fired on the back end, $callback
-                 *                                       is 'wp_widget_control', see $_callback.
-                 *     @type array          $params      An associative array of multi-widget arguments.
-                 *     @type string         $classname   CSS class applied to the widget container.
-                 *     @type string         $description The widget description.
-                 *     @type array          $_callback   When the hook is fired on the back end, $_callback is populated
-                 *                                       with an array containing the widget object, see $callback.
+                 *     @type string   $name        Name of the widget.
+                 *     @type string   $id          Widget ID.
+                 *     @type callable $callback    When the hook is fired on the front end, $callback is an array
+                 *                                 containing the widget object. Fired on the back end, $callback
+                 *                                 is 'wp_widget_control', see $_callback.
+                 *     @type array    $params      An associative array of multi-widget arguments.
+                 *     @type string   $classname   CSS class applied to the widget container.
+                 *     @type string   $description The widget description.
+                 *     @type array    $_callback   When the hook is fired on the back end, $_callback is populated
+                 *                                 with an array containing the widget object, see $callback.
                  * }
                  */
@@ -858 +858 @@
  * @global array $wp_registered_widgets
  *
- * @param string|false $callback      Optional, Widget callback to check. Default false.
- * @param int|false    $widget_id     Optional. Widget ID. Optional, but needed for checking. Default false.
- * @param string|false $id_base       Optional. The base ID of a widget created by extending WP_Widget. Default false.
- * @param bool         $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. Default true.
+ * @param callable|false $callback      Optional, Widget callback to check. Default false.
+ * @param int|false      $widget_id     Optional. Widget ID. Optional, but needed for checking. Default false.
+ * @param string|false   $id_base       Optional. The base ID of a widget created by extending WP_Widget. Default false.
+ * @param bool           $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. Default true.
  * @return string|false False if widget is not active or id of sidebar in which the widget is active.
  */