From 80a32b4bc8f2e0e9bdfd0a7dcf5b4ead40067a4b Mon Sep 17 00:00:00 2001
From: Drew Jaynes <info@drewapicture.com>
Date: Sun, 27 Sep 2015 00:37:24 +0000
Subject: [PATCH] Docs: Improve documentation for the `__construct()`,
 `widget()`, `update()`, and `form()` methods in `WP_Widget_Search`.

Props leemon.
Fixes #34025. See #34013.

Built from https://develop.svn.wordpress.org/trunk@34611


git-svn-id: http://core.svn.wordpress.org/trunk@34575 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/version.php                       |  2 +-
 .../widgets/class-wp-widget-search.php        | 39 +++++++++++++++----
 2 files changed, 32 insertions(+), 9 deletions(-)

diff --git a/wp-includes/version.php b/wp-includes/version.php
index 868c39b86f..2fc2fabe98 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.4-alpha-34610';
+$wp_version = '4.4-alpha-34611';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
diff --git a/wp-includes/widgets/class-wp-widget-search.php b/wp-includes/widgets/class-wp-widget-search.php
index 522834eee4..29bbbf8a5d 100644
--- a/wp-includes/widgets/class-wp-widget-search.php
+++ b/wp-includes/widgets/class-wp-widget-search.php
@@ -16,14 +16,26 @@
  */
 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.") );
 		parent::__construct( 'search', _x( 'Search', 'Search widget' ), $widget_ops );
 	}
 
 	/**
-	 * @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 ) {
 		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
@@ -41,20 +53,31 @@ class WP_Widget_Search extends WP_Widget {
 	}
 
 	/**
-	 * @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 ) {
 		$instance = $old_instance;