class-wp-widget-recent-comments.php 5.7 KB

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