Changeset 34612

Timestamp:

09/27/2015 12:41:47 AM (9 years ago)

Author:

DrewAPicture

Message:

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

Props leemon.
Fixes #34024. See #34013.

File:

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

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

@@ -17 +17 @@
 class WP_Widget_RSS extends WP_Widget {
 
+    /**
+     * Sets up a new RSS widget instance.
+     *
+     * @since 2.8.0
+     * @access public
+     */
     public function __construct() {
         $widget_ops = array( 'description' => __('Entries from any RSS or Atom feed.') );
@@ -24 +30 @@
 
     /**
-     * @param array $args
-     * @param array $instance
+     * Outputs the content for the current RSS widget instance.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param array $args     Display arguments including 'before_title', 'after_title',
+     *                        'before_widget', and 'after_widget'.
+     * @param array $instance Settings for the current RSS widget instance.
      */
     public function widget( $args, $instance ) {
@@ -80 +92 @@
 
     /**
-     * @param array $new_instance
-     * @param array $old_instance
-     * @return array
+     * Handles updating settings for the current RSS 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 Updated settings to save.
      */
     public function update( $new_instance, $old_instance ) {
@@ -90 +108 @@
 
     /**
-     * @param array $instance
+     * Outputs the settings form for the RSS widget.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param array $instance Current settings.
      */
     public function form( $instance ) {