BBP_Replies_Widget
bbPress Replies Widget
Description Description
Adds a widget which displays the replies list
Source Source
File: includes/common/widgets.php
class BBP_Replies_Widget extends WP_Widget { /** * bbPress Replies Widget * * Registers the replies widget * * @since 2.0.0 bbPress (r2653) */ public function __construct() { $widget_ops = apply_filters( 'bbp_replies_widget_options', array( 'classname' => 'widget_display_replies', 'description' => esc_html__( 'A list of the most recent replies.', 'bbpress' ), 'customize_selective_refresh' => true ) ); parent::__construct( false, esc_html__( '(bbPress) Recent Replies', 'bbpress' ), $widget_ops ); } /** * Register the widget * * @since 2.0.0 bbPress (r3389) */ public static function register_widget() { register_widget( 'BBP_Replies_Widget' ); } /** * Displays the output, the replies list * * @since 2.0.0 bbPress (r2653) * * @param array $args * @param array $instance */ public function widget( $args, $instance ) { // 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_replies_widget_title', $settings['title'], $instance, $this->id_base ); // Note: private and hidden forums will be excluded via the // bbp_pre_get_posts_normalize_forum_visibility action and function. $widget_query = new WP_Query( array( // What and when 'post_type' => bbp_get_reply_post_type(), 'post_status' => bbp_get_public_reply_statuses(), 'posts_per_page' => (int) $settings['max_shown'], // Performance 'ignore_sticky_posts' => true, 'no_found_rows' => true, 'update_post_term_cache' => false, 'update_post_meta_cache' => false ) ); // Bail if no replies if ( ! $widget_query->have_posts() ) { return; } // 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-replies-widget"> <?php while ( $widget_query->have_posts() ) : $widget_query->the_post(); ?> <li> <?php // Verify the reply ID $reply_id = bbp_get_reply_id( $widget_query->post->ID ); $reply_link = '<a class="bbp-reply-topic-title" href="' . esc_url( bbp_get_reply_url( $reply_id ) ) . '" title="' . esc_attr( bbp_get_reply_excerpt( $reply_id, 50 ) ) . '">' . esc_html( bbp_get_reply_topic_title( $reply_id ) ) . '</a>'; $time = get_the_time( 'U', $reply_id ); $show_date = '<time datetime="' . gmdate( 'Y-m-d H:i:s', $time ) . '">' . esc_html( bbp_get_time_since( $time ) ) . '</time>'; // Only query user if showing them if ( ! empty( $settings['show_user'] ) ) : $author_link = bbp_get_reply_author_link( array( 'post_id' => $reply_id, 'type' => 'both', 'size' => 14 ) ); else : $author_link = false; endif; // Reply author, link, and timestamp if ( ! empty( $settings['show_date'] ) && ! empty( $author_link ) ) : // translators: 1: reply author, 2: reply link, 3: reply timestamp printf( esc_html_x( '%1$s on %2$s %3$s', 'widgets', 'bbpress' ), $author_link, $reply_link, $show_date ); // Reply link and timestamp elseif ( ! empty( $settings['show_date'] ) ) : echo $reply_link . ' ' . $show_date; // Reply author and title elseif ( ! empty( $author_link ) ) : // translators: 1: reply author, 2: reply link printf( esc_html_x( '%1$s on %2$s', 'widgets', 'bbpress' ), $author_link, $reply_link ); // Only the reply title else : echo $reply_link; endif; ?> </li> <?php endwhile; ?> </ul> <?php echo $args['after_widget']; // Reset the $post global wp_reset_postdata(); // Output the current buffer echo ob_get_clean(); } /** * Update the reply widget options * * @since 2.0.0 bbPress (r2653) * * @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'] ); $instance['max_shown'] = (int) $new_instance['max_shown']; // Date $instance['show_date'] = isset( $new_instance['show_date'] ) ? (bool) $new_instance['show_date'] : false; // Author $instance['show_user'] = isset( $new_instance['show_user'] ) ? (bool) $new_instance['show_user'] : false; return $instance; } /** * Output the reply widget options form * * @since 2.0.0 bbPress (r2653) * * @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> <p><label for="<?php echo $this->get_field_id( 'max_shown' ); ?>"><?php esc_html_e( 'Maximum replies to show:', 'bbpress' ); ?> <input class="widefat" id="<?php echo $this->get_field_id( 'max_shown' ); ?>" name="<?php echo $this->get_field_name( 'max_shown' ); ?>" type="text" value="<?php echo esc_attr( $settings['max_shown'] ); ?>" /></label></p> <p><label for="<?php echo $this->get_field_id( 'show_date' ); ?>"><?php esc_html_e( 'Show post date:', 'bbpress' ); ?> <input type="checkbox" id="<?php echo $this->get_field_id( 'show_date' ); ?>" name="<?php echo $this->get_field_name( 'show_date' ); ?>" <?php checked( true, $settings['show_date'] ); ?> value="1" /></label></p> <p><label for="<?php echo $this->get_field_id( 'show_user' ); ?>"><?php esc_html_e( 'Show reply author:', 'bbpress' ); ?> <input type="checkbox" id="<?php echo $this->get_field_id( 'show_user' ); ?>" name="<?php echo $this->get_field_name( 'show_user' ); ?>" <?php checked( true, $settings['show_user'] ); ?> value="1" /></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__( 'Recent Replies', 'bbpress' ), 'max_shown' => 5, 'show_date' => false, 'show_user' => false ), 'replies_widget_settings' ); } }
Changelog Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |
Methods Methods
- __construct — bbPress Replies Widget
- form — Output the reply widget options form
- parse_settings — Merge the widget settings into defaults array.
- register_widget — Register the widget
- update — Update the reply widget options
- widget — Displays the output, the replies list