[Summary view] [Print] [Text view]

   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       */
  24  	public function __construct() {
  25          $widget_ops = array(
  26              'classname'                   => 'widget_recent_comments',
  27              'description'                 => __( 'Your site&#8217;s most recent comments.' ),
  28              'customize_selective_refresh' => true,
  29          );
  30          parent::__construct( 'recent-comments', __( 'Recent Comments' ), $widget_ops );
  31          $this->alt_option_name = 'widget_recent_comments';
  32  
  33          if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
  34              add_action( 'wp_head', array( $this, 'recent_comments_style' ) );
  35          }
  36      }
  37  
  38      /**
  39       * Outputs the default styles for the Recent Comments widget.
  40       *
  41       * @since 2.8.0
  42       */
  43  	public function recent_comments_style() {
  44          /**
  45           * Filters the Recent Comments default widget styles.
  46           *
  47           * @since 3.1.0
  48           *
  49           * @param bool   $active  Whether the widget is active. Default true.
  50           * @param string $id_base The widget ID.
  51           */
  52          if ( ! current_theme_supports( 'widgets' ) // Temp hack #14876
  53              || ! apply_filters( 'show_recent_comments_widget_style', true, $this->id_base ) ) {
  54              return;
  55          }
  56  
  57          $type_attr = current_theme_supports( 'html5', 'style' ) ? '' : ' type="text/css"';
  58  
  59          printf(
  60              '<style%s>.recentcomments a{display:inline !important;padding:0 !important;margin:0 !important;}</style>',
  61              $type_attr
  62          );
  63      }
  64  
  65      /**
  66       * Outputs the content for the current Recent Comments widget instance.
  67       *
  68       * @since 2.8.0
  69       *
  70       * @param array $args     Display arguments including 'before_title', 'after_title',
  71       *                        'before_widget', and 'after_widget'.
  72       * @param array $instance Settings for the current Recent Comments widget instance.
  73       */
  74  	public function widget( $args, $instance ) {
  75          if ( ! isset( $args['widget_id'] ) ) {
  76              $args['widget_id'] = $this->id;
  77          }
  78  
  79          $output = '';
  80  
  81          $title = ( ! empty( $instance['title'] ) ) ? $instance['title'] : __( 'Recent Comments' );
  82  
  83          /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
  84          $title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
  85  
  86          $number = ( ! empty( $instance['number'] ) ) ? absint( $instance['number'] ) : 5;
  87          if ( ! $number ) {
  88              $number = 5;
  89          }
  90  
  91          $comments = get_comments(
  92              /**
  93               * Filters the arguments for the Recent Comments widget.
  94               *
  95               * @since 3.4.0
  96               * @since 4.9.0 Added the `$instance` parameter.
  97               *
  98               * @see WP_Comment_Query::query() for information on accepted arguments.
  99               *
 100               * @param array $comment_args An array of arguments used to retrieve the recent comments.
 101               * @param array $instance     Array of settings for the current widget.
 102               */
 103              apply_filters(
 104                  'widget_comments_args',
 105                  array(
 106                      'number'      => $number,
 107                      'status'      => 'approve',
 108                      'post_status' => 'publish',
 109                  ),
 110                  $instance
 111              )
 112          );
 113  
 114          $output .= $args['before_widget'];
 115          if ( $title ) {
 116              $output .= $args['before_title'] . $title . $args['after_title'];
 117          }
 118  
 119          $output .= '<ul id="recentcomments">';
 120          if ( is_array( $comments ) && $comments ) {
 121              // Prime cache for associated posts. (Prime post term cache if we need it for permalinks.)
 122              $post_ids = array_unique( wp_list_pluck( $comments, 'comment_post_ID' ) );
 123              _prime_post_caches( $post_ids, strpos( get_option( 'permalink_structure' ), '%category%' ), false );
 124  
 125              foreach ( (array) $comments as $comment ) {
 126                  $output .= '<li class="recentcomments">';
 127                  $output .= sprintf(
 128                      /* translators: Comments widget. 1: Comment author, 2: Post link. */
 129                      _x( '%1$s on %2$s', 'widgets' ),
 130                      '<span class="comment-author-link">' . get_comment_author_link( $comment ) . '</span>',
 131                      '<a href="' . esc_url( get_comment_link( $comment ) ) . '">' . get_the_title( $comment->comment_post_ID ) . '</a>'
 132                  );
 133                  $output .= '</li>';
 134              }
 135          }
 136          $output .= '</ul>';
 137          $output .= $args['after_widget'];
 138  
 139          echo $output;
 140      }
 141  
 142      /**
 143       * Handles updating settings for the current Recent Comments widget instance.
 144       *
 145       * @since 2.8.0
 146       *
 147       * @param array $new_instance New settings for this instance as input by the user via
 148       *                            WP_Widget::form().
 149       * @param array $old_instance Old settings for this instance.
 150       * @return array Updated settings to save.
 151       */
 152  	public function update( $new_instance, $old_instance ) {
 153          $instance           = $old_instance;
 154          $instance['title']  = sanitize_text_field( $new_instance['title'] );
 155          $instance['number'] = absint( $new_instance['number'] );
 156          return $instance;
 157      }
 158  
 159      /**
 160       * Outputs the settings form for the Recent Comments widget.
 161       *
 162       * @since 2.8.0
 163       *
 164       * @param array $instance Current settings.
 165       */
 166  	public function form( $instance ) {
 167          $title  = isset( $instance['title'] ) ? $instance['title'] : '';
 168          $number = isset( $instance['number'] ) ? absint( $instance['number'] ) : 5;
 169          ?>
 170          <p><label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label>
 171          <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>
 172  
 173          <p><label for="<?php echo $this->get_field_id( 'number' ); ?>"><?php _e( 'Number of comments to show:' ); ?></label>
 174          <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>
 175          <?php
 176      }
 177  
 178      /**
 179       * Flushes the Recent Comments widget cache.
 180       *
 181       * @since 2.8.0
 182       *
 183       * @deprecated 4.4.0 Fragment caching was removed in favor of split queries.
 184       */
 185  	public function flush_widget_cache() {
 186          _deprecated_function( __METHOD__, '4.4.0' );
 187      }
 188  }