wp-includes/widgets/class-wp-widget-recent-comments.php

   1 <?php
   2 /**
   3  * Widget API: WP_Widget_Recent_Comments class
   4  *
   5  * @package WordPress
   6  * @subpackage Widgets
   7  * @since 4.4.0
   8  */
   9
  10 /**
  11  * Core class used to implement a Recent Comments widget.
  12  *
  13  * @since 2.8.0
  14  *
  15  * @see WP_Widget
  16  */
  17 class WP_Widget_Recent_Comments extends WP_Widget {
  18
  19         /**
  20          * Sets up a new Recent Comments widget instance.
  21          *
  22          * @since 2.8.0
  23          * @access public
  24          */
  25         public function __construct() {
  26                 $widget_ops = array(
  27                         'classname' => 'widget_recent_comments',
  28                         'description' => __( 'Your site&#8217;s most recent comments.' ),
  29                         'customize_selective_refresh' => true,
  30                 );
  31                 parent::__construct( 'recent-comments', __( 'Recent Comments' ), $widget_ops );
  32                 $this->alt_option_name = 'widget_recent_comments';
  33
  34                 if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
  35                         add_action( 'wp_head', array( $this, 'recent_comments_style' ) );
  36                 }
  37         }
  38
  39         /**
  40          * Outputs the default styles for the Recent Comments widget.
  41          *
  42          * @since 2.8.0
  43          * @access public
  44          */
  45         public function recent_comments_style() {
  46                 /**
  47                  * Filters the Recent Comments default widget styles.
  48                  *
  49                  * @since 3.1.0
  50                  *
  51                  * @param bool   $active  Whether the widget is active. Default true.
  52                  * @param string $id_base The widget ID.
  53                  */
  54                 if ( ! current_theme_supports( 'widgets' ) // Temp hack #14876
  55                         || ! apply_filters( 'show_recent_comments_widget_style', true, $this->id_base ) )
  56                         return;
  57                 ?>
  58                 <style type="text/css">.recentcomments a{display:inline !important;padding:0 !important;margin:0 !important;}</style>
  59                 <?php
  60         }
  61
  62         /**
  63          * Outputs the content for the current Recent Comments widget instance.
  64          *
  65          * @since 2.8.0
  66          * @access public
  67          *
  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.
  71          */
  72         public function widget( $args, $instance ) {
  73                 if ( ! isset( $args['widget_id'] ) )
  74                         $args['widget_id'] = $this->id;
  75
  76                 $output = '';
  77
  78                 $title = ( ! empty( $instance['title'] ) ) ? $instance['title'] : __( 'Recent Comments' );
  79
  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 );
  82
  83                 $number = ( ! empty( $instance['number'] ) ) ? absint( $instance['number'] ) : 5;
  84                 if ( ! $number )
  85                         $number = 5;
  86
  87                 /**
  88                  * Filters the arguments for the Recent Comments widget.
  89                  *
  90                  * @since 3.4.0
  91                  *
  92                  * @see WP_Comment_Query::query() for information on accepted arguments.
  93                  *
  94                  * @param array $comment_args An array of arguments used to retrieve the recent comments.
  95                  */
  96                 $comments = get_comments( apply_filters( 'widget_comments_args', array(
  97                         'number'      => $number,
  98                         'status'      => 'approve',
  99                         'post_status' => 'publish'
 100                 ) ) );
 101
 102                 $output .= $args['before_widget'];
 103                 if ( $title ) {
 104                         $output .= $args['before_title'] . $title . $args['after_title'];
 105                 }
 106
 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 );
 112
 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>'
 119                                 );
 120                                 $output .= '</li>';
 121                         }
 122                 }
 123                 $output .= '</ul>';
 124                 $output .= $args['after_widget'];
 125
 126                 echo $output;
 127         }
 128
 129         /**
 130          * Handles updating settings for the current Recent Comments widget instance.
 131          *
 132          * @since 2.8.0
 133          * @access public
 134          *
 135          * @param array $new_instance New settings for this instance as input by the user via
 136          *                            WP_Widget::form().
 137          * @param array $old_instance Old settings for this instance.
 138          * @return array Updated settings to save.
 139          */
 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'] );
 144                 return $instance;
 145         }
 146
 147         /**
 148          * Outputs the settings form for the Recent Comments widget.
 149          *
 150          * @since 2.8.0
 151          * @access public
 152          *
 153          * @param array $instance Current settings.
 154          */
 155         public function form( $instance ) {
 156                 $title = isset( $instance['title'] ) ? $instance['title'] : '';
 157                 $number = isset( $instance['number'] ) ? absint( $instance['number'] ) : 5;
 158                 ?>
 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>
 161
 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>
 164                 <?php
 165         }
 166
 167         /**
 168          * Flushes the Recent Comments widget cache.
 169          *
 170          * @since 2.8.0
 171          * @access public
 172          *
 173          * @deprecated 4.4.0 Fragment caching was removed in favor of split queries.
 174          */
 175         public function flush_widget_cache() {
 176                 _deprecated_function( __METHOD__, '4.4.0' );
 177         }
 178 }