Changeset 34615

Timestamp:

09/27/2015 12:53:36 AM (9 years ago)

Author:

DrewAPicture

Message:

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

Props leemon.
Fixes #34021. See #34013.

File:

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

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

@@ -17 +17 @@
 class WP_Widget_Pages extends WP_Widget {
 
+    /**
+     * Sets up a new Pages widget instance.
+     *
+     * @since 2.8.0
+     * @access public
+     */
     public function __construct() {
         $widget_ops = array('classname' => 'widget_pages', 'description' => __( 'A list of your site’s Pages.') );
@@ -23 +29 @@
 
     /**
-     * @param array $args
-     * @param array $instance
+     * Outputs the content for the current Pages 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 Pages widget instance.
      */
     public function widget( $args, $instance ) {
@@ -76 +88 @@
 
     /**
-     * @param array $new_instance
-     * @param array $old_instance
-     * @return array
+     * Handles updating settings for the current Pages 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 ) {
@@ -95 +113 @@
 
     /**
-     * @param array $instance
+     * Outputs the settings form for the Pages widget.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param array $instance Current settings.
      */
     public function form( $instance ) {
         //Defaults
         $instance = wp_parse_args( (array) $instance, array( 'sortby' => 'post_title', 'title' => '', 'exclude' => '') );
-    ?>
+        ?>
         <p>
             <label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php _e( 'Title:' ); ?></label>
@@ -119 +142 @@
             <small><?php _e( 'Page IDs, separated by commas.' ); ?></small>
         </p>
-<?php
+        <?php
     }