Changeset 34617

Timestamp:

09/27/2015 12:59:44 AM (9 years ago)

Author:

DrewAPicture

Message:

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

Props leemon.
Fixes #34019. See #34013.

File:

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

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

@@ -17 +17 @@
 class WP_Widget_Links extends WP_Widget {
 
+    /**
+     * Sets up a new Links widget instance.
+     *
+     * @since 2.8.0
+     * @access public
+     */
     public function __construct() {
         $widget_ops = array('description' => __( "Your blogroll" ) );
@@ -23 +29 @@
 
     /**
-     * @param array $args
-     * @param array $instance
+     * Outputs the content for the current Links 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 Links widget instance.
      */
     public function widget( $args, $instance ) {
@@ -69 +81 @@
 
     /**
-     * @param array $new_instance
-     * @param array $old_instance
-     * @return array
+     * Handles updating settings for the current Links 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 ) {
@@ -92 +110 @@
 
     /**
-     * @param array $instance
+     * Outputs the settings form for the Links widget.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param array $instance Current settings.
      */
     public function form( $instance ) {
@@ -101 +124 @@
         if ( ! $limit = intval( $instance['limit'] ) )
             $limit = -1;
-?>
+            ?>
         <p>
         <label for="<?php echo $this->get_field_id('category'); ?>"><?php _e( 'Select Link Category:' ); ?></label>
@@ -136 +159 @@
         <input id="<?php echo $this->get_field_id('limit'); ?>" name="<?php echo $this->get_field_name('limit'); ?>" type="text" value="<?php echo $limit == -1 ? '' : intval( $limit ); ?>" size="3" />
         </p>
-<?php
+        <?php
     }
 }