Changeset 37064

Timestamp:

03/23/2016 05:09:48 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing information to the WP_Widget PHP4 constructor DocBlock.

Also add several missing at @access tags to other method DocBlocks and clarify parameter docs for WP_Widget::form_callback().

Props raimy.
See #36298.

File:

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

trunk/src/wp-includes/class-wp-widget.php

@@ -163 +163 @@
          * PHP4 constructor.
          *
-         * @param string $id_base
-         * @param string $name
-         * @param array  $widget_options
-         * @param array  $control_options
+         * @since 2.8.0
+         * @access public
+         *
+         * @see __construct()
+         * 
+         * @param string $id_base         Optional Base ID for the widget, lowercase and unique. If left empty,
+         *                                a portion of the widget's class name will be used Has to be unique.
+         * @param string $name            Name for the widget displayed on the configuration page.
+         * @param array  $widget_options  Optional. Widget options. See wp_register_sidebar_widget() for information
+         *                                on accepted arguments. Default empty array.
+         * @param array  $control_options Optional. Widget control options. See wp_register_widget_control() for
+         *                                information on accepted arguments. Default empty array.
          */
         public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
@@ -180 +188 @@
          * @since 2.8.0
          * @since 4.4.0 Array format field names are now accepted.
+         * @access public
          *
          * @param string $field_name Field name
@@ -213 +222 @@
          *
          * @since 2.8.0
-         * @access private
+         * @access public
          */
         public function _register() {
@@ -245 +254 @@
          *
          * @since 2.8.0
-         * @access private
+         * @access public
          *
          * @param int $number The unique order number of this widget instance compared to other
@@ -259 +268 @@
          *
          * @since 2.8.0
+         * @access public
          *
          * @return callable Display callback.
@@ -270 +280 @@
          *
          * @since 2.8.0
+         * @access public
          *
          * @return callable Update callback.
@@ -281 +292 @@
          *
          * @since 2.8.0
+         * @access public
          *
          * @return callable Form callback.
@@ -458 +470 @@
          * @access public
          *
-         * @param int|array $widget_args Widget instance number or array of widget arguments.
+         * @param int|array $widget_args {
+         *     Optional. Internal order number of the widget instance, or array of multi-widget arguments.
+         *     Default 1.
+         *
+         *     @type int $number Number increment used for multiples of the same widget.
+         * }
          * @return string|null
          */
@@ -518 +535 @@
          *
          * @since 2.8.0
-         * @access private
+         * @access public
          *
          * @param integer $number Optional. The unique order number of this widget instance