Changeset 34560

Timestamp:

09/25/2015 08:30:02 PM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Improve the method docs for the widget(), update(), form(), and __construct() methods in the WP_Widget base class.

See #34013. See #32246.

File:

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

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

@@ -88 +88 @@
 
         /**
-         * Echo the widget content.
-         *
-         * Subclasses should over-ride this function to generate their widget code.
-         *
-         * @since 2.8.0
-         * @access public
-         *
-         * @param array $args     Display arguments including before_title, after_title,
-         *                        before_widget, and after_widget.
+         * Echoes the widget content.
+         *
+         * Sub-classes should over-ride this function to generate their widget code.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $args     Display arguments including 'before_title', 'after_title',
+         *                        'before_widget', and 'after_widget'.
          * @param array $instance The settings for the particular instance of the widget.
          */
@@ -104 +104 @@
 
         /**
-         * Update a particular instance.
-         *
-         * This function should check that $new_instance is set correctly. The newly-calculated
+         * Updates a particular instance of a widget.
+         *
+         * This function should check that `$new_instance` is set correctly. The newly-calculated
          * value of `$instance` should be returned. If false is returned, the instance won't be
          * saved/updated.
@@ -114 +114 @@
          *
          * @param array $new_instance New settings for this instance as input by the user via
-         *                            {@see WP_Widget::form()}.
+         *                            WP_Widget::form().
          * @param array $old_instance Old settings for this instance.
          * @return array Settings to save or bool false to cancel saving.
@@ -123 +123 @@
 
         /**
-         * Output the settings update form.
+         * Outputs the settings update form.
          *
          * @since 2.8.0
@@ -131 +131 @@
          * @return string Default return is 'noform'.
          */
-        public function form($instance) {
+        public function form( $instance ) {
                 echo '<p class="no-options-widget">' . __('There are no options for this widget.') . '</p>';
                 return 'noform';
@@ -147 +147 @@
          *                                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 {@see wp_register_sidebar_widget()} for
+         * @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.
-         * @param array  $control_options Optional. Widget control options. See {@see wp_register_widget_control()}
-         *                                for information on accepted arguments. Default empty array.
          */
         public function __construct( $id_base, $name, $widget_options = array(), $control_options = array() ) {
@@ -161 +161 @@
 
         /**
-         * PHP4 constructor
+         * PHP4 constructor.
          *
          * @param string $id_base