コメントをフロントで階層表示しながら管理する方法

Cocoonカスタマイズ集
この記事は約9分で読めます。
記事内に広告が含まれています。

はじめに

WordPressの管理画面にあるコメント一覧では、コメントが階層表示されず、親コメントと返信コメントの関係が分かりにくいという問題があります。

特に、返信が多い記事では、どのコメントに対する返信なのかを確認するために、コメントの内容や投稿先を個別に確認する必要があります。

そこで、管理画面のコメント一覧ではなく、フロントページにコメント管理機能を追加することで、実際のコメント表示を確認しながら操作できるようにします。

この記事では、この方法について説明します。

目的

コメント一覧

管理画面のコメント一覧では、親コメントと返信コメントの関係が階層表示されないため、コメントの流れを把握しにくいという問題があります(図1参照)。

この問題を改善するため、ログインユーザーがフロントページでコメントを管理できるようにします。

主な機能は次のとおりです。

  • コメントの階層表示:親コメントと返信コメントの関係を確認しながら管理できる
  • 未承認コメントの表示:承認前のコメントもフロントに表示し、管理対象を確認できる
  • 承認状態の視覚的な区別:未承認コメントの背景色を変更し、承認済みコメントと見分けやすくする
  • コメントの管理操作:承認、未承認への変更、ゴミ箱への移動、スパムへの分類を行える

これにより、実際のコメント表示を確認しながら、返信の流れを把握して管理できるようになります。

完成イメージ

実装手順

以下のコードをfunctions.phpに追加します。

/**
 * コメント管理リンクの生成処理を設定
 *
 * @param WP_Comment $comment コメントオブジェクト
 * @return string コメント管理リンクのHTML
 */
if (!function_exists('cocoon_st_moderation_links')):
function cocoon_st_moderation_links($comment) {
  $id = (int) $comment->comment_ID;

  if (!current_user_can('edit_comment', $id)) {
    return '';
  }

  // コメントの承認状態に応じて操作項目を設定
  if ($comment->comment_approved === '0') {
    $actions = [
      'approve' => '承認',
      'trash'   => 'ゴミ箱',
    ];
  } else {
    $actions = [
      'unapprove' => '未承認に戻す',
      'trash'     => 'ゴミ箱',
    ];
  }

  // 非ログインユーザーのコメントにだけスパム操作を追加
  if (empty($comment->user_id)) {
    $actions['spam'] = 'スパム';
  }

  ob_start();
  ?>
  <span class="st-comment-moderate">
    <?php foreach ($actions as $do => $label) : ?>
      <?php
      // 操作URLとnonceを設定
      $url = wp_nonce_url(
        add_query_arg(
          [
            'action'     => 'cocoon_st_moderate',
            'comment_id' => $id,
            'do'         => $do,
          ],
          admin_url('admin-post.php')
        ),
        'cocoon_st_moderate_' . $id
      );

      // 削除系の操作に確認メッセージを設定
      $confirm = in_array($do, ['trash', 'spam'], true)
        ? ' onclick="return confirm(\'' . esc_js($label . 'にしますか?') . '\');"'
        : '';
      ?>
      <a href="<?php echo esc_url($url); ?>" class="st-mod-<?php echo esc_attr($do); ?>"<?php echo $confirm; ?>>
        <?php echo esc_html($label); ?>
      </a>
    <?php endforeach; ?>
  </span>
  <?php
  return ob_get_clean();
}
endif;


// 管理者は未承認コメントも表示に変更
add_filter('comments_template_query_args', function ($args) {
  if (current_user_can('moderate_comments')) {
    $args['status'] = 'all';
  }

  return $args;
});


// コメントリストのクラスを変更
add_filter('comment_class', function ($classes, $css_class, $comment_id, $comment) {
  // 未承認ココメントのあ場合
  if (!is_admin() && $comment && $comment->comment_approved === '0') {
    $classes[] = 'st-comment-unapproved';
  }

  return $classes;
}, 10, 4);


// 編集リンクの括弧を除去しコメント管理リンクを追加
add_filter('edit_comment_link', function ($link, $comment_id) {
  if (is_admin()) {
    return $link;
  }

  // デフォルト形式の編集リンクから括弧を除去
  $link = preg_replace(
    '#>\s*[((]\s*([^<>]*?)\s*[))]\s*</a>#u',
    '>$1</a>',
    $link
  );

  // コメントオブジェクトを取得
  $comment = get_comment($comment_id);

  if (!$comment) {
    return $link;
  }

  return '<span class="st-comment-actions">' . $link . cocoon_st_moderation_links($comment) . '</span>';
}, 10, 2);


// コメント管理操作を実行
add_action('admin_post_cocoon_st_moderate', function () {
  // リクエスト値を取得
  $id = isset($_GET['comment_id']) ? absint($_GET['comment_id']) : 0;
  $do = isset($_GET['do']) ? sanitize_key($_GET['do']) : '';

  // nonceチェック
  check_admin_referer('cocoon_st_moderate_' . $id);

  // 権限チェック
  if (!$id || !current_user_can('edit_comment', $id)) {
    wp_die('権限がありません。', '', ['response' => 403]);
  }

  // 操作名とコメントステータスの対応を設定
  $map = [
    'approve'   => 'approve',
    'unapprove' => 'hold',
    'trash'     => 'trash',
    'spam'      => 'spam',
  ];

  if (!isset($map[$do])) {
    wp_die('不正な操作です。', '', ['response' => 400]);
  }

  // コメントのステータスを変更
  wp_set_comment_status($id, $map[$do]);

  // 元のページへ戻るURLを取得
  $back = wp_get_referer();

  if (!$back) {
    $back = home_url('/');
  }

  // 承認状態の変更時は対象コメントへのアンカーを設定
  if (in_array($do, ['approve', 'unapprove'], true)) {
    $back = preg_replace('/#.*$/', '', $back);
    $back .= '#comment-' . $id;
  }

  // 元のページへリダイレクトして処理を終了
  wp_safe_redirect($back);
  exit;
});


// フロント用JS・CSSを追加
add_action('wp_enqueue_scripts', function () {
  if (!is_singular()) {
    return;
  }

  ob_start();
  ?>
  .st-comment-unapproved {
    > .st-comment-body,
    > .comment-body {
      background-color: #fcf9e8;
      border-left: 4px solid #d63638;
      padding-left: 8px;
    }
  }

  .comment-awaiting-moderation {
    display: none;

    + br {
      display: none;
    }
  }

  .st-comment-actions {
    display: block;

    .comment-edit-link {
      margin-left: 0;
    }
  }

  .comment-edit-link,
  .st-comment-moderate a {
    border: 1px solid #1967d2;
    border-radius: 3px;
    display: inline-block;
    font-size: 12px;
    padding: 1px 6px;
    text-decoration: none;

    &:hover {
      color: #1967d2;
    }
  }

  .st-comment-moderate {
    .st-mod-trash,
    .st-mod-spam {
      border-color: #c62828;
      color: #c62828;

      &:hover {
        border-color: #c62828;
        color: #c62828;
      }
    }
  }
  <?php

  $handle = 'comment-moderation';

  wp_register_style($handle, false);
  wp_enqueue_style($handle);
  wp_add_inline_style($handle, ob_get_clean());
});

さいごに

今回紹介した方法を使えば、WordPressの管理画面を開かなくても、フロントページでコメントの親子関係を確認しながら管理できます。
未承認コメントの確認や承認状態の変更、ゴミ箱への移動なども、その場で操作できるため、返信が多い記事でもコメントの流れを把握しやすくなります。
コメント管理の手間を減らしたい場合は、ぜひ導入してみてください。

タイトルとURLをコピーしました