Changeset 4579 for trunk/includes/common/widgets.php

Timestamp:

12/16/2012 08:19:21 AM (12 years ago)

Author:

jmdodd

Message:

Introduce dedicated forum search.

• Search forums, topics, and replies.
• Add new search functions, including bbp_has_search_results().
• Provide templates for search results.
• Fixes #1575.

File:

• trunk/includes/common/widgets.php (modified) (1 diff)

trunk/includes/common/widgets.php

@@ -306 +306 @@
      * @uses BBP_Views_Widget::get_field_id() To output the field id
      * @uses BBP_Views_Widget::get_field_name() To output the field name
+     */
+    public function form( $instance ) {
+        $title = !empty( $instance['title'] ) ? esc_attr( $instance['title'] ) : ''; ?>
+
+        <p>
+            <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:', 'bbpress' ); ?>
+                <input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo $title; ?>" />
+            </label>
+        </p>
+
+        <?php
+    }
+}
+
+/**
+ * bbPress Search Widget
+ *
+ * Adds a widget which displays the forum search form
+ *
+ * @since bbPress (r4579)
+ *
+ * @uses WP_Widget
+ */
+class BBP_Search_Widget extends WP_Widget {
+
+    /**
+     * bbPress Search Widget
+     *
+     * Registers the search widget
+     *
+     * @since bbPress (r4579)
+     *
+     * @uses apply_filters() Calls 'bbp_search_widget_options' with the
+     *                        widget options
+     */
+    public function __construct() {
+        $widget_ops = apply_filters( 'bbp_search_widget_options', array(
+            'classname'   => 'widget_display_search',
+            'description' => __( 'The bbPress forum search form.', 'bbpress' )
+        ) );
+
+        parent::__construct( false, __( '(bbPress) Forum Search Form', 'bbpress' ), $widget_ops );
+    }
+
+    /**
+     * Register the widget
+     *
+     * @since bbPress (r4579)
+     *
+     * @uses register_widget()
+     */
+    public static function register_widget() {
+        register_widget( 'BBP_Search_Widget' );
+    }
+
+    /**
+     * Displays the output, the search form
+     *
+     * @since bbPress (r4579)
+     *
+     * @uses apply_filters() Calls 'bbp_search_widget_title' with the title
+     * @uses get_template_part() To get the search form
+     */
+    public function widget( $args, $instance ) {
+
+        // Typical WordPress filter
+        $title = apply_filters( 'widget_title',            $instance['title'], $instance, $this->id_base );
+
+        // bbPress filter
+        $title = apply_filters( 'bbp_search_widget_title', $instance['title'], $instance, $this->id_base );
+
+        echo $args['before_widget'];
+        echo $args['before_title'] . $title . $args['after_title'];
+
+        bbp_get_template_part( 'form', 'search' );
+
+        echo $args['after_widget'];
+    }
+
+    /**
+     * Update the widget options
+     *
+     * @since bbPress (r4579)
+     *
+     * @param array $new_instance The new instance options
+     * @param array $old_instance The old instance options
+     */
+    public function update( $new_instance, $old_instance ) {
+        $instance          = $old_instance;
+        $instance['title'] = strip_tags( $new_instance['title'] );
+
+        return $instance;
+    }
+
+    /**
+     * Output the search widget options form
+     *
+     * @since bbPress (r4579)
+     *
+     * @param $instance Instance
+     * @uses BBP_Search_Widget::get_field_id() To output the field id
+     * @uses BBP_Search_Widget::get_field_name() To output the field name
      */
     public function form( $instance ) {