Changeset 34619 for trunk/src/wp-includes/widgets/class-wp-widget-calendar.php

Timestamp:

09/27/2015 01:06:20 AM (11 years ago)

Author:

DrewAPicture

Message:

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

Props leemon.
Fixes #34017. See #34013.

File:

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

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

@@ -27 +27 @@
         private static $instance = 0;
 
+        /**
+         * Sets up a new Calendar widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         */
         public function __construct() {
                 $widget_ops = array('classname' => 'widget_calendar', 'description' => __( 'A calendar of your site’s Posts.') );
@@ -33 +39 @@
 
         /**
-         * @param array $args
-         * @param array $instance
+         * Outputs the content for the current Calendar 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 The settings for the particular instance of the widget.
          */
         public function widget( $args, $instance ) {
@@ -57 +69 @@
 
         /**
-         * @param array $new_instance
-         * @param array $old_instance
-         * @return array
+         * Handles updating settings for the current Calendar 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 ) {
@@ -69 +87 @@
 
         /**
-         * @param array $instance
+         * Outputs the settings form for the Calendar widget.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $instance Current settings.
          */
         public function form( $instance ) {
                 $instance = wp_parse_args( (array) $instance, array( 'title' => '' ) );
                 $title = sanitize_text_field( $instance['title'] );
-?>
+                ?>
                 <p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e('Title:'); ?></label>
                 <input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($title); ?>" /></p>
-<?php
+                <?php
         }
 }