BBP_Search_Widget
bbPress Search Widget
Description Description
Adds a widget which displays the forum search form
Source Source
File: includes/common/widgets.php
class BBP_Search_Widget extends WP_Widget { /** * bbPress Search Widget * * Registers the search widget * * @since 2.3.0 bbPress (r4579) */ public function __construct() { $widget_ops = apply_filters( 'bbp_search_widget_options', array( 'classname' => 'widget_display_search', 'description' => esc_html__( 'The bbPress forum search form.', 'bbpress' ), 'customize_selective_refresh' => true ) ); parent::__construct( false, esc_html__( '(bbPress) Forum Search Form', 'bbpress' ), $widget_ops ); } /** * Register the widget * * @since 2.3.0 bbPress (r4579) */ public static function register_widget() { register_widget( 'BBP_Search_Widget' ); } /** * Displays the output, the search form * * @since 2.3.0 bbPress (r4579) */ public function widget( $args, $instance ) { // Bail if search is disabled if ( ! bbp_allow_search() ) { return; } // Get widget settings $settings = $this->parse_settings( $instance ); // Typical WordPress filter $settings['title'] = apply_filters( 'widget_title', $settings['title'], $instance, $this->id_base ); // bbPress filter $settings['title'] = apply_filters( 'bbp_search_widget_title', $settings['title'], $instance, $this->id_base ); echo $args['before_widget']; if ( ! empty( $settings['title'] ) ) { echo $args['before_title'] . $settings['title'] . $args['after_title']; } bbp_get_template_part( 'form', 'search' ); echo $args['after_widget']; } /** * Update the widget options * * @since 2.3.0 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 2.3.0 bbPress (r4579) * * @param $instance Instance */ public function form( $instance ) { // Get widget settings $settings = $this->parse_settings( $instance ); ?> <p> <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php esc_html_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 esc_attr( $settings['title'] ); ?>" /> </label> </p> <?php } /** * Merge the widget settings into defaults array. * * @since 2.3.0 bbPress (r4802) * * @param $instance Instance */ public function parse_settings( $instance = array() ) { return bbp_parse_args( $instance, array( 'title' => esc_html__( 'Search Forums', 'bbpress' ) ), 'search_widget_settings' ); } }
Changelog Changelog
Version | Description |
---|---|
2.3.0 | Introduced. |
Methods Methods
- __construct — bbPress Search Widget
- form — Output the search widget options form
- parse_settings — Merge the widget settings into defaults array.
- register_widget — Register the widget
- update — Update the widget options
- widget — Displays the output, the search form