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