Changeset 34611

Timestamp:

09/27/2015 12:36:26 AM (11 years ago)

Author:

DrewAPicture

Message:

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

Props leemon.
Fixes #34025. See #34013.

File:

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

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

@@ -17 +17 @@
 class WP_Widget_Search extends WP_Widget {
 
+        /**
+         * Sets up a new Search widget instance.
+         *
+         * @since 2.8.0
+         * @access public
+         */
         public function __construct() {
                 $widget_ops = array('classname' => 'widget_search', 'description' => __( "A search form for your site.") );
@@ -23 +29 @@
 
         /**
-         * @param array $args
-         * @param array $instance
+         * Outputs the content for the current Search 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 Search widget instance.
          */
         public function widget( $args, $instance ) {
@@ -42 +54 @@
 
         /**
-         * @param array $instance
+         * Outputs the settings form for the Search 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 = $instance['title'];
-?>
+                ?>
                 <p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e('Title:'); ?> <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); ?>" /></label></p>
-<?php
+                <?php
         }
 
         /**
-         * @param array $new_instance
-         * @param array $old_instance
-         * @return array
+         * Handles updating settings for the current Search 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.
          */
         public function update( $new_instance, $old_instance ) {