[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Server-side rendering of the `core/latest-comments` block.
   4   *
   5   * @package WordPress
   6   */
   7  
   8  /**
   9   * Get the post title.
  10   *
  11   * The post title is fetched and if it is blank then a default string is
  12   * returned.
  13   *
  14   * Copied from `wp-admin/includes/template.php`, but we can't include that
  15   * file because:
  16   *
  17   * 1. It causes bugs with test fixture generation and strange Docker 255 error
  18   *    codes.
  19   * 2. It's in the admin; ideally we *shouldn't* be including files from the
  20   *    admin for a block's output. It's a very small/simple function as well,
  21   *    so duplicating it isn't too terrible.
  22   *
  23   * @since 3.3.0
  24   *
  25   * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
  26   * @return string The post title if set; "(no title)" if no title is set.
  27   */
  28  function wp_latest_comments_draft_or_post_title( $post = 0 ) {
  29      $title = get_the_title( $post );
  30      if ( empty( $title ) ) {
  31          $title = __( '(no title)' );
  32      }
  33      return $title;
  34  }
  35  
  36  /**
  37   * Renders the `core/latest-comments` block on server.
  38   *
  39   * @since 5.1.0
  40   *
  41   * @param array $attributes The block attributes.
  42   *
  43   * @return string Returns the post content with latest comments added.
  44   */
  45  function render_block_core_latest_comments( $attributes ) {
  46      // Handle backward compatibility: check for old displayExcerpt attribute
  47      if ( isset( $attributes['displayExcerpt'] ) ) {
  48          $display_content = $attributes['displayExcerpt'] ? 'excerpt' : 'none';
  49      } else {
  50          $display_content = isset( $attributes['displayContent'] ) ? $attributes['displayContent'] : 'excerpt';
  51      }
  52  
  53      $comments = get_comments(
  54          /** This filter is documented in wp-includes/widgets/class-wp-widget-recent-comments.php */
  55          apply_filters(
  56              'widget_comments_args',
  57              array(
  58                  'number'      => $attributes['commentsToShow'],
  59                  'status'      => 'approve',
  60                  'post_status' => 'publish',
  61              ),
  62              array()
  63          )
  64      );
  65  
  66      $list_items_markup = '';
  67      if ( ! empty( $comments ) ) {
  68          // Prime the cache for associated posts. This is copied from \WP_Widget_Recent_Comments::widget().
  69          $post_ids = array_unique( wp_list_pluck( $comments, 'comment_post_ID' ) );
  70          _prime_post_caches( $post_ids, strpos( get_option( 'permalink_structure' ), '%category%' ), false );
  71  
  72          foreach ( $comments as $comment ) {
  73              $list_items_markup .= '<li class="wp-block-latest-comments__comment">';
  74              if ( $attributes['displayAvatar'] ) {
  75                  $avatar = get_avatar(
  76                      $comment,
  77                      48,
  78                      '',
  79                      '',
  80                      array(
  81                          'class' => 'wp-block-latest-comments__comment-avatar',
  82                      )
  83                  );
  84                  if ( $avatar ) {
  85                      $list_items_markup .= $avatar;
  86                  }
  87              }
  88  
  89              $list_items_markup .= '<article>';
  90              $list_items_markup .= '<footer class="wp-block-latest-comments__comment-meta">';
  91              $author_url         = get_comment_author_url( $comment );
  92              if ( empty( $author_url ) && ! empty( $comment->user_id ) ) {
  93                  $author_url = get_author_posts_url( $comment->user_id );
  94              }
  95  
  96              $author_markup = '';
  97              if ( $author_url ) {
  98                  $author_markup .= '<a class="wp-block-latest-comments__comment-author" href="' . esc_url( $author_url ) . '">' . get_comment_author( $comment ) . '</a>';
  99              } else {
 100                  $author_markup .= '<span class="wp-block-latest-comments__comment-author">' . get_comment_author( $comment ) . '</span>';
 101              }
 102  
 103              // `_draft_or_post_title` calls `esc_html()` so we don't need to wrap that call in
 104              // `esc_html`.
 105              $post_title = '<a class="wp-block-latest-comments__comment-link" href="' . esc_url( get_comment_link( $comment ) ) . '">' . wp_latest_comments_draft_or_post_title( $comment->comment_post_ID ) . '</a>';
 106  
 107              $list_items_markup .= sprintf(
 108                  /* translators: 1: author name (inside <a> or <span> tag, based on if they have a URL), 2: post title related to this comment */
 109                  __( '%1$s on %2$s' ),
 110                  $author_markup,
 111                  $post_title
 112              );
 113  
 114              if ( $attributes['displayDate'] ) {
 115                  $list_items_markup .= sprintf(
 116                      '<time datetime="%1$s" class="wp-block-latest-comments__comment-date">%2$s</time>',
 117                      esc_attr( get_comment_date( 'c', $comment ) ),
 118                      date_i18n( get_option( 'date_format' ), get_comment_date( 'U', $comment ) )
 119                  );
 120              }
 121              $list_items_markup .= '</footer>';
 122              if ( 'full' === $display_content ) {
 123                  $list_items_markup .= '<div class="wp-block-latest-comments__comment-excerpt">' . wpautop( get_comment_text( $comment ) ) . '</div>';
 124              } elseif ( 'excerpt' === $display_content ) {
 125                  $list_items_markup .= '<div class="wp-block-latest-comments__comment-excerpt">' . wpautop( get_comment_excerpt( $comment ) ) . '</div>';
 126              }
 127              $list_items_markup .= '</article></li>';
 128          }
 129      }
 130  
 131      $classnames = array();
 132      if ( $attributes['displayAvatar'] ) {
 133          $classnames[] = 'has-avatars';
 134      }
 135      if ( $attributes['displayDate'] ) {
 136          $classnames[] = 'has-dates';
 137      }
 138      if ( 'none' !== $display_content ) {
 139          $classnames[] = 'has-excerpts';
 140      }
 141      if ( empty( $comments ) ) {
 142          $classnames[] = 'no-comments';
 143      }
 144      $wrapper_attributes = get_block_wrapper_attributes( array( 'class' => implode( ' ', $classnames ) ) );
 145  
 146      return ! empty( $comments ) ? sprintf(
 147          '<ol %1$s>%2$s</ol>',
 148          $wrapper_attributes,
 149          $list_items_markup
 150      ) : sprintf(
 151          '<div %1$s>%2$s</div>',
 152          $wrapper_attributes,
 153          __( 'No comments to show.' )
 154      );
 155  }
 156  
 157  /**
 158   * Registers the `core/latest-comments` block.
 159   *
 160   * @since 5.3.0
 161   */
 162  function register_block_core_latest_comments() {
 163      register_block_type_from_metadata(
 164          __DIR__ . '/latest-comments',
 165          array(
 166              'render_callback' => 'render_block_core_latest_comments',
 167          )
 168      );
 169  }
 170  
 171  add_action( 'init', 'register_block_core_latest_comments' );