Changeset 34613

Timestamp:

09/27/2015 12:45:42 AM (8 years ago)

Author:

DrewAPicture

Message:

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

Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34023. See #34013.

File:

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

trunk/src/wp-includes/widgets/class-wp-widget-recent-posts.php

@@ -9 +9 @@
 
 /**
- * Core class used to implement a Recent_Posts widget.
+ * Core class used to implement a Recent Posts widget.
  *
  * @since 2.8.0
@@ -17 +17 @@
 class WP_Widget_Recent_Posts extends WP_Widget {
 
+    /**
+     * Sets up a new Recent Posts widget instance.
+     *
+     * @since 2.8.0
+     * @access public
+     */
     public function __construct() {
         $widget_ops = array('classname' => 'widget_recent_entries', 'description' => __( "Your site’s most recent Posts.") );
@@ -24 +30 @@
 
     /**
-     * @param array $args
-     * @param array $instance
+     * Outputs the content for the current Recent Posts 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 Recent Posts widget instance.
      */
     public function widget( $args, $instance ) {
@@ -59 +71 @@
 
         if ($r->have_posts()) :
-?>
+        ?>
         <?php echo $args['before_widget']; ?>
         <?php if ( $title ) {
@@ -75 +87 @@
         </ul>
         <?php echo $args['after_widget']; ?>
-<?php
+        <?php
         // Reset the global $the_post as this query will have stomped on it
         wp_reset_postdata();
@@ -83 +95 @@
 
     /**
-     * @param array $new_instance
-     * @param array $old_instance
-     * @return array
+     * Handles updating the settings for the current Recent Posts 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 ) {
@@ -96 +114 @@
 
     /**
-     * @param array $instance
+     * Outputs the settings form for the Recent Posts widget.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param array $instance Current settings.
      */
     public function form( $instance ) {