[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              'show_instance_in_rest'       => 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       */
  44  	public function recent_comments_style() {
  45          /**
  46           * Filters the Recent Comments default widget styles.
  47           *
  48           * @since 3.1.0
  49           *
  50           * @param bool   $active  Whether the widget is active. Default true.
  51           * @param string $id_base The widget ID.
  52           */
  53          if ( ! current_theme_supports( 'widgets' ) // Temp hack #14876.
  54              || ! apply_filters( 'show_recent_comments_widget_style', true, $this->id_base ) ) {
  55              return;
  56          }
  57  
  58          echo '<style>.recentcomments a{display:inline !important;padding:0 !important;margin:0 !important;}</style>';
  59      }
  60  
  61      /**
  62       * Outputs the content for the current Recent Comments widget instance.
  63       *
  64       * @since 2.8.0
  65       * @since 5.4.0 Creates a unique HTML ID for the `<ul>` element
  66       *              if more than one instance is displayed on the page.
  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          static $first_instance = true;
  74  
  75          if ( ! isset( $args['widget_id'] ) ) {
  76              $args['widget_id'] = $this->id;
  77          }
  78  
  79          $output = '';
  80  
  81          $default_title = __( 'Recent Comments' );
  82          $title         = ( ! empty( $instance['title'] ) ) ? $instance['title'] : $default_title;
  83  
  84          /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
  85          $title = apply_filters( 'widget_title', $title, $instance, $this->id_base );
  86  
  87          $number = ( ! empty( $instance['number'] ) ) ? absint( $instance['number'] ) : 5;
  88          if ( ! $number ) {
  89              $number = 5;
  90          }
  91  
  92          $comments = get_comments(
  93              /**
  94               * Filters the arguments for the Recent Comments widget.
  95               *
  96               * @since 3.4.0
  97               * @since 4.9.0 Added the `$instance` parameter.
  98               *
  99               * @see WP_Comment_Query::query() for information on accepted arguments.
 100               *
 101               * @param array $comment_args An array of arguments used to retrieve the recent comments.
 102               * @param array $instance     Array of settings for the current widget.
 103               */
 104              apply_filters(
 105                  'widget_comments_args',
 106                  array(
 107                      'number'      => $number,
 108                      'status'      => 'approve',
 109                      'post_status' => 'publish',
 110                  ),
 111                  $instance
 112              )
 113          );
 114  
 115          $output .= $args['before_widget'];
 116          if ( $title ) {
 117              $output .= $args['before_title'] . $title . $args['after_title'];
 118          }
 119  
 120          $recent_comments_id = ( $first_instance ) ? 'recentcomments' : "recentcomments-{$this->number}";
 121          $first_instance     = false;
 122  
 123          $format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';
 124  
 125          /** This filter is documented in wp-includes/widgets/class-wp-nav-menu-widget.php */
 126          $format = apply_filters( 'navigation_widgets_format', $format );
 127  
 128          if ( 'html5' === $format ) {
 129              // The title may be filtered: Strip out HTML and make sure the aria-label is never empty.
 130              $title      = trim( strip_tags( $title ) );
 131              $aria_label = $title ? $title : $default_title;
 132              $output    .= '<nav aria-label="' . esc_attr( $aria_label ) . '">';
 133          }
 134  
 135          $output .= '<ul id="' . esc_attr( $recent_comments_id ) . '">';
 136          if ( is_array( $comments ) && $comments ) {
 137              // Prime cache for associated posts. (Prime post term cache if we need it for permalinks.)
 138              $post_ids = array_unique( wp_list_pluck( $comments, 'comment_post_ID' ) );
 139              _prime_post_caches( $post_ids, strpos( get_option( 'permalink_structure' ), '%category%' ), false );
 140  
 141              foreach ( (array) $comments as $comment ) {
 142                  $output .= '<li class="recentcomments">';
 143                  $output .= sprintf(
 144                      /* translators: Comments widget. 1: Comment author, 2: Post link. */
 145                      _x( '%1$s on %2$s', 'widgets' ),
 146                      '<span class="comment-author-link">' . get_comment_author_link( $comment ) . '</span>',
 147                      '<a href="' . esc_url( get_comment_link( $comment ) ) . '">' . get_the_title( $comment->comment_post_ID ) . '</a>'
 148                  );
 149                  $output .= '</li>';
 150              }
 151          }
 152          $output .= '</ul>';
 153  
 154          if ( 'html5' === $format ) {
 155              $output .= '</nav>';
 156          }
 157  
 158          $output .= $args['after_widget'];
 159  
 160          echo $output;
 161      }
 162  
 163      /**
 164       * Handles updating settings for the current Recent Comments widget instance.
 165       *
 166       * @since 2.8.0
 167       *
 168       * @param array $new_instance New settings for this instance as input by the user via
 169       *                            WP_Widget::form().
 170       * @param array $old_instance Old settings for this instance.
 171       * @return array Updated settings to save.
 172       */
 173  	public function update( $new_instance, $old_instance ) {
 174          $instance           = $old_instance;
 175          $instance['title']  = sanitize_text_field( $new_instance['title'] );
 176          $instance['number'] = absint( $new_instance['number'] );
 177          return $instance;
 178      }
 179  
 180      /**
 181       * Outputs the settings form for the Recent Comments widget.
 182       *
 183       * @since 2.8.0
 184       *
 185       * @param array $instance Current settings.
 186       */
 187  	public function form( $instance ) {
 188          $title  = $instance['title'] ?? '';
 189          $number = isset( $instance['number'] ) ? absint( $instance['number'] ) : 5;
 190          ?>
 191          <p>
 192              <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label>
 193              <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 ); ?>" />
 194          </p>
 195  
 196          <p>
 197              <label for="<?php echo $this->get_field_id( 'number' ); ?>"><?php _e( 'Number of comments to show:' ); ?></label>
 198              <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" />
 199          </p>
 200          <?php
 201      }
 202  
 203      /**
 204       * Flushes the Recent Comments widget cache.
 205       *
 206       * @since 2.8.0
 207       *
 208       * @deprecated 4.4.0 Fragment caching was removed in favor of split queries.
 209       */
 210  	public function flush_widget_cache() {
 211          _deprecated_function( __METHOD__, '4.4.0' );
 212      }
 213  }