[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/widgets/ -> class-wp-widget-recent-comments.php (source)

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


Generated: Wed Sep 18 01:00:03 2019 Cross-referenced by PHPXref 0.7.1