Ticket #34025: 34025.2.patch

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

@@ -16 +16 @@
  */
 class WP_Widget_Search extends WP_Widget {
 
+        /**
+         * Creates 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 );
@@ -22 +28 @@
         }
 
         /**
-         * @param array $args
-         * @param array $instance
+         * Echoes the current Search widget instance content.
+         *
+         * @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 ) {
                 /** This filter is documented in src/wp-includes/widgets/class-wp-widget-pages.php */
@@ -41 +53 @@
         }
 
         /**
-         * @param array $instance
+         * Outputs the current Search widget instance settings update form.
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array $instance Current settings.
          */
         public function form( $instance ) {
                 $instance = wp_parse_args( (array) $instance, array( 'title' => '') );
@@ -52 +69 @@
         }
 
         /**
-         * @param array $new_instance
-         * @param array $old_instance
-         * @return array
+         * Handles updating settings for the current Search widget instance.
+         *
+         * This function should check that `$new_instance` is set correctly. The newly-calculated
+         * value of `$instance` should be returned. If false is returned, the instance won't be
+         * saved/updated.
+         *
+         * @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 Settings to save or bool false to cancel saving.
          */
         public function update( $new_instance, $old_instance ) {
                 $instance = $old_instance;