Changeset 34609

Timestamp:

09/27/2015 12:26:56 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Text.

(first!) Props leemon.
Fixes #34027.

File:

• trunk/src/wp-includes/widgets/class-wp-widget-text.php (modified) (6 diffs)

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

@@ -17 +17 @@
 class WP_Widget_Text extends WP_Widget {
 
+        /**
+         * Sets up a new Text widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         */
         public function __construct() {
                 $widget_ops = array('classname' => 'widget_text', 'description' => __('Arbitrary text or HTML.'));
@@ -24 +30 @@
 
         /**
-         * Outputs the Text widget content.
+         * Outputs the content for the current Text widget instance.
          *
          * @since 2.8.0
@@ -31 +37 @@
          * @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.
+         * @param array $instance Settings for the current Text widget instance.
          */
         public function widget( $args, $instance ) {
@@ -62 +68 @@
 
         /**
-         * @param array $new_instance
-         * @param array $old_instance
-         * @return array
+         * Handles updating settings for the current Text widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $new_instance New settings for this instance as input by the user via
+         *                            WP_Widget::form().
+         * @param array $old_instance Old settings for this instance.
+         * @return array Settings to save or bool false to cancel saving.
          */
         public function update( $new_instance, $old_instance ) {
@@ -78 +90 @@
 
         /**
-         * @param array $instance
+         * Outputs the Text widget settings form.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $instance Current settings.
          */
         public function form( $instance ) {
@@ -92 +109 @@
 
                 <p><input id="<?php echo $this->get_field_id('filter'); ?>" name="<?php echo $this->get_field_name('filter'); ?>" type="checkbox"<?php checked( $filter ); ?> />&nbsp;<label for="<?php echo $this->get_field_id('filter'); ?>"><?php _e('Automatically add paragraphs'); ?></label></p>
-<?php
+                <?php
         }
 }