BBP_Views_Widget
bbPress Views Widget
Description Description
Adds a widget which displays the view list
Source Source
File: includes/common/widgets.php
class BBP_Views_Widget extends WP_Widget { /** * bbPress View Widget * * Registers the view widget * * @since 2.0.0 bbPress (r3020) */ public function __construct() { $widget_ops = apply_filters( 'bbp_views_widget_options', array( 'classname' => 'widget_display_views', 'description' => esc_html__( 'A list of registered optional topic views.', 'bbpress' ), 'customize_selective_refresh' => true ) ); parent::__construct( false, esc_html__( '(bbPress) Topic Views List', 'bbpress' ), $widget_ops ); } /** * Register the widget * * @since 2.0.0 bbPress (r3389) */ public static function register_widget() { register_widget( 'BBP_Views_Widget' ); } /** * Displays the output, the view list * * @since 2.0.0 bbPress (r3020) * * @param array $args Arguments * @param array $instance Instance */ public function widget( $args = array(), $instance = array() ) { // Only output widget contents if views exist if ( ! bbp_get_views() ) { 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_view_widget_title', $settings['title'], $instance, $this->id_base ); // Start an output buffer ob_start(); echo $args['before_widget']; if ( ! empty( $settings['title'] ) ) { echo $args['before_title'] . $settings['title'] . $args['after_title']; } ?> <ul class="bbp-views-widget"> <?php foreach ( array_keys( bbp_get_views() ) as $view ) : ?> <li><a class="bbp-view-title" href="<?php bbp_view_url( $view ); ?>"><?php bbp_view_title( $view ); ?></a></li> <?php endforeach; ?> </ul> <?php echo $args['after_widget']; // Output the current buffer echo ob_get_clean(); } /** * Update the view widget options * * @since 2.0.0 bbPress (r3020) * * @param array $new_instance The new instance options * @param array $old_instance The old instance options */ public function update( $new_instance = array(), $old_instance = array() ) { $instance = $old_instance; $instance['title'] = strip_tags( $new_instance['title'] ); return $instance; } /** * Output the view widget options form * * @since 2.0.0 bbPress (r3020) * * @param $instance Instance */ public function form( $instance = array() ) { // 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' => '' ), 'view_widget_settings' ); } }
Changelog Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |
Methods Methods
- __construct — bbPress View Widget
- form — Output the view widget options form
- parse_settings — Merge the widget settings into defaults array.
- register_widget — Register the widget
- update — Update the view widget options
- widget — Displays the output, the view list