3 * Widget API: WP_Widget_Recent_Comments class
11 * Core class used to implement a Recent Comments widget.
17 class WP_Widget_Recent_Comments extends WP_Widget {
20 * Sets up a new Recent Comments widget instance.
25 public function __construct() {
27 'classname' => 'widget_recent_comments',
28 'description' => __( 'Your site’s most recent comments.' ),
29 'customize_selective_refresh' => true,
31 parent::__construct( 'recent-comments', __( 'Recent Comments' ), $widget_ops );
32 $this->alt_option_name = 'widget_recent_comments';
34 if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
35 add_action( 'wp_head', array( $this, 'recent_comments_style' ) );
40 * Outputs the default styles for the Recent Comments widget.
45 public function recent_comments_style() {
47 * Filters the Recent Comments default widget styles.
51 * @param bool $active Whether the widget is active. Default true.
52 * @param string $id_base The widget ID.
54 if ( ! current_theme_supports( 'widgets' ) // Temp hack #14876
55 || ! apply_filters( 'show_recent_comments_widget_style', true, $this->id_base ) )
58 <style type="text/css">.recentcomments a{display:inline !important;padding:0 !important;margin:0 !important;}</style>
63 * Outputs the content for the current Recent Comments widget instance.
68 * @param array $args Display arguments including 'before_title', 'after_title',
69 * 'before_widget', and 'after_widget'.
70 * @param array $instance Settings for the current Recent Comments widget instance.
72 public function widget( $args, $instance ) {
73 if ( ! isset( $args['widget_id'] ) )
74 $args['widget_id'] = $this->id;
78 $title = ( ! empty( $instance['title'] ) ) ? $instance['title'] : __( 'Recent Comments' );
80 /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
81 $title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
83 $number = ( ! empty( $instance['number'] ) ) ? absint( $instance['number'] ) : 5;
88 * Filters the arguments for the Recent Comments widget.
92 * @see WP_Comment_Query::query() for information on accepted arguments.
94 * @param array $comment_args An array of arguments used to retrieve the recent comments.
96 $comments = get_comments( apply_filters( 'widget_comments_args', array(
98 'status' => 'approve',
99 'post_status' => 'publish'
102 $output .= $args['before_widget'];
104 $output .= $args['before_title'] . $title . $args['after_title'];
107 $output .= '<ul id="recentcomments">';
108 if ( is_array( $comments ) && $comments ) {
109 // Prime cache for associated posts. (Prime post term cache if we need it for permalinks.)
110 $post_ids = array_unique( wp_list_pluck( $comments, 'comment_post_ID' ) );
111 _prime_post_caches( $post_ids, strpos( get_option( 'permalink_structure' ), '%category%' ), false );
113 foreach ( (array) $comments as $comment ) {
114 $output .= '<li class="recentcomments">';
115 /* translators: comments widget: 1: comment author, 2: post link */
116 $output .= sprintf( _x( '%1$s on %2$s', 'widgets' ),
117 '<span class="comment-author-link">' . get_comment_author_link( $comment ) . '</span>',
118 '<a href="' . esc_url( get_comment_link( $comment ) ) . '">' . get_the_title( $comment->comment_post_ID ) . '</a>'
124 $output .= $args['after_widget'];
130 * Handles updating settings for the current Recent Comments widget instance.
135 * @param array $new_instance New settings for this instance as input by the user via
137 * @param array $old_instance Old settings for this instance.
138 * @return array Updated settings to save.
140 public function update( $new_instance, $old_instance ) {
141 $instance = $old_instance;
142 $instance['title'] = sanitize_text_field( $new_instance['title'] );
143 $instance['number'] = absint( $new_instance['number'] );
148 * Outputs the settings form for the Recent Comments widget.
153 * @param array $instance Current settings.
155 public function form( $instance ) {
156 $title = isset( $instance['title'] ) ? $instance['title'] : '';
157 $number = isset( $instance['number'] ) ? absint( $instance['number'] ) : 5;
159 <p><label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label>
160 <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( $title ); ?>" /></p>
162 <p><label for="<?php echo $this->get_field_id( 'number' ); ?>"><?php _e( 'Number of comments to show:' ); ?></label>
163 <input class="tiny-text" id="<?php echo $this->get_field_id( 'number' ); ?>" name="<?php echo $this->get_field_name( 'number' ); ?>" type="number" step="1" min="1" value="<?php echo $number; ?>" size="3" /></p>
168 * Flushes the Recent Comments widget cache.
173 * @deprecated 4.4.0 Fragment caching was removed in favor of split queries.
175 public function flush_widget_cache() {
176 _deprecated_function( __METHOD__, '4.4.0' );