未承認コメントを投稿者が10分以内に編集できるようにする方法

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

はじめに

WordPressでは、コメントの承認を管理者が確認してから公開するように設定できます。
迷惑な投稿や不適切な内容がそのまま公開されるのを防げるため、個人サイトでも役立つ機能です。

しかし、標準機能ではコメントを送信した人が自分の投稿内容を後から編集することはできません。
誤字や入力ミスに気付いた場合も、管理者に修正を依頼するか、改めてコメントを送信する必要があります。

特に、会員登録やログインを設けていない個人サイトでは、投稿者本人であることを確認する手段も限られています。

そこで、承認前のコメントを投稿者本人が一定時間だけ編集できる仕組みを追加します。

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

目的

今回の目的は、ログインを必要としないサイトでも、コメントを送信した人が自分の未承認コメントを投稿から一定時間内(10分)に編集できるようにすることです。

実現する機能は次の3つです。

  1. 投稿者本人のコメントだけを編集できる
    ログインを必要としないサイトでは、投稿者をアカウント情報によって確認できません。
    そこで、コメントを送信した際に、そのブラウザーに本人確認用の情報を保存します。
    コメント側にも対応する情報を記録し、両者を照合することで、同じブラウザーからアクセスした投稿者本人かどうかを確認します。
    これにより、他の閲覧者が未承認コメントを編集することを防ぎます。
  1. 未承認コメントを投稿者本人にだけ表示する
    通常、承認されていないコメントは一般の閲覧者には表示されません。
    今回の方法では、投稿者本人と確認できた場合に限り、自分の未承認コメントを画面上に表示します。
    他の閲覧者には表示されないため、管理者の承認前にコメントが公開されてしまう心配もありません。
  1. 編集できる時間を10分に制限する
    コメントをいつまでも編集できる状態にすると、管理者が確認した内容と実際に公開される内容が変わってしまう可能性があります。
    そこで、編集できる時間を投稿から10分間に制限します。
    10分を過ぎると編集欄は表示されなくなり、更新もできません。
    編集可能な時間は最初の投稿時点から数え、編集を繰り返しても延長されない仕組みです。

注意点

この方法は、ログインを必要としない個人サイトでの利用を想定しています。

本人確認にはブラウザーに保存した情報を使用するため、別のブラウザーや端末からは編集できません。
また、保存された情報を削除した場合も、本人確認ができなくなります。

編集できる時間は投稿から10分間です。
時間を過ぎた場合や、管理者が承認した後は、投稿者自身で修正することはできません。

なお、コメントの承認や削除などの管理は、従来どおり管理者が行います。
今回の方法は、管理者による確認をなくすものではなく、承認前の入力ミスなどを投稿者自身で修正できるようにするための補助的な機能です。

完成イメージ

実装手順

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

/**
 * コメント編集権限を確認
 *
 * Cookieのトークンとコメントに保存されたハッシュを照合し、
 * 本人が投稿した未承認コメントで、編集期限内であることを確認する
 *
 * @param WP_Comment|null $comment コメントオブジェクト
 * @return bool 編集可能な場合はtrue、それ以外はfalse
 */
if (!function_exists('get_my_front_page_types')):
function my_comment_edit_is_owner($comment) {
  // ログインユーザーは処理対象外
  if (!$comment || is_user_logged_in()) {
    return false;
  }

  // 編集期限を確認(10分)
  $edit_limit = 10 * MINUTE_IN_SECONDS;

  // 未承認コメントのみ編集可能(承認後の内容すり替えを防止)
  if ($comment->comment_approved !== '0') {
    return false;
  }

  // Cookieを取得
  $token = isset($_COOKIE['my_comment_edit_token'])
    ? wp_unslash($_COOKIE['my_comment_edit_token'])
    : '';

  if (!preg_match('/^[a-f0-9]{64}$/', $token)) {
    return false;
  }

  // 保存済みトークンと照合
  $saved_hash = get_comment_meta($comment->comment_ID, '_my_comment_edit_token', true);

  if (!$saved_hash || !hash_equals($saved_hash, hash('sha256', $token))) {
    return false;
  }

  // コメントの投稿時刻を取得
  $posted_time = (int) get_comment_meta($comment->comment_ID, '_my_comment_edit_time', true);

  if (!$posted_time) {
    return false;
  }

  if (time() > $posted_time + $edit_limit) {
    return false;
  }

  return true;
}
endif;


// コメント送信時にトークンを発行・保存
add_action('comment_post', function ($comment_id) {
  // ログインユーザーは処理対象外
  if (is_user_logged_in()) {
    return;
  }

  $cookie_name = 'my_comment_edit_token';

  // Cookieを取得
  $token = isset($_COOKIE[$cookie_name])
    ? wp_unslash($_COOKIE[$cookie_name])
    : '';

  // 初回投稿時にトークンを発行
  if (!preg_match('/^[a-f0-9]{64}$/', $token)) {
    try {
      $token = bin2hex(random_bytes(32));
    } catch (Exception $e) {
      return;
    }

    // Cookieを保存(1年間)
    if (headers_sent()) {
      return;
    }

    $cookie_saved = setcookie($cookie_name, $token, [
      'expires'  => time() + YEAR_IN_SECONDS,
      'path'     => defined('COOKIEPATH') && COOKIEPATH ? COOKIEPATH : '/',
      'domain'   => defined('COOKIE_DOMAIN') ? COOKIE_DOMAIN : '',
      'secure'   => is_ssl(),
      'httponly' => true,
      'samesite' => 'Lax',
    ]);

    if (!$cookie_saved) {
      return;
    }

    // 同一リクエスト内でCookieを参照できるよう設定
    $_COOKIE[$cookie_name] = $token;
  }

  // コメントにトークンのハッシュと投稿時刻を保存
  update_comment_meta($comment_id, '_my_comment_edit_token', hash('sha256', $token));
  update_comment_meta($comment_id, '_my_comment_edit_time', time());

});


// 未ログインユーザーのコメント取得対象を全件に変更
add_filter('comments_template_query_args', function ($args) {
  if (is_user_logged_in() || !is_singular()) {
    return $args;
  }

  $args['status'] = 'all';

  return $args;
});


// 承認済みコメントと本人の未承認コメントだけを表示
add_filter('comments_array', function ($comments, $post_id) {
  if (is_user_logged_in()) {
    return $comments;
  }

  $token = isset($_COOKIE['my_comment_edit_token'])
    ? wp_unslash($_COOKIE['my_comment_edit_token'])
    : '';

  // Cookieの形式を確認
  if (!preg_match('/^[a-f0-9]{64}$/', $token)) {
    $token = '';
  }

  $token_hash = $token ? hash('sha256', $token) : '';

  // 表示対象のコメントを抽出
  return array_values(array_filter($comments, function ($comment) use ($token_hash) {
    // 承認済みコメントは表示
    if ($comment->comment_approved === '1') {
      return true;
    }

    // 未承認コメント以外は処理対象外
    if ($comment->comment_approved !== '0' || !$token_hash) {
      return false;
    }

    // トークンを照合
    $saved_hash = get_comment_meta($comment->comment_ID, '_my_comment_edit_token', true);

    return $saved_hash && hash_equals($saved_hash, $token_hash);
  }));
}, 10, 2);


// コメント本文の下に編集フォームを表示
add_filter('comment_text', function ($text, $comment, $args) {
  if (!my_comment_edit_is_owner($comment)) {
    return $text;
  }

  $form  = '<form class="my-comment-edit-form" method="post" action="' . esc_url(admin_url('admin-post.php')) . '">';
  $form .= '<input type="hidden" name="action" value="my_comment_edit">';
  $form .= '<input type="hidden" name="comment_id" value="' . esc_attr($comment->comment_ID) . '">';
  $form .= wp_nonce_field('comment_edit_action', 'comment_edit_nonce', true, false);
  $form .= '<textarea name="comment_content" rows="5" required>' . esc_textarea($comment->comment_content) . '</textarea>';
  $form .= '<div class="reply">';
  $form .= '<button class="comment-reply-link" type="submit"><i class="fas fa-sync-alt comment-icon"></i>更新</button>';
  $form .= '</div>';
  $form .= '</form>';

  return $text . $form;
}, 999, 3);


// 非ログインユーザーコメント編集
add_action('admin_post_nopriv_my_comment_edit', function() {
  // コメントIDを取得
  $comment_id = isset($_POST['comment_id'])
    ? absint($_POST['comment_id'])
    : 0;

  $comment = get_comment($comment_id);

  // 権限チェック
  if (!$comment || !my_comment_edit_is_owner($comment)) {
    wp_die('コメントを編集できません。');
  }

  // nonceチェック
  check_admin_referer('comment_edit_action', 'comment_edit_nonce');

  // コメント本文を取得・サニタイズ
  $content = isset($_POST['comment_content'])
    ? wp_kses_post(wp_unslash($_POST['comment_content']))
    : '';

  if (trim(wp_strip_all_tags($content)) === '') {
    wp_die('コメントを入力してください。');
  }

  // コメント本文を更新
  $result = wp_update_comment(wp_slash([
    'comment_ID'      => $comment_id,
    'comment_content' => $content,
  ]));

  if ($result === false) {
    wp_die('コメントを更新できませんでした。');
  }

  // 更新したコメントへ移動
  wp_safe_redirect(get_comment_link($comment));
  exit;
});


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

  ob_start();
  ?>
  .my-comment-edit-form {
    margin-bottom: 12px;
  }

  .my-comment-edit-form textarea {
    box-sizing: border-box;
    display: inline-block;
    margin-bottom: 8px;
    width: 100%;
  }

  .my-comment-edit-form button {
    background: transparent;
    cursor: pointer;
    display: inline-block;
  }
  <?php

  $handle ='my-comment-edit';

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

さいごに

今回紹介した方法を使えば、WordPressの標準機能では難しい、未承認コメントの投稿者本人による編集を実現できます。
投稿者本人の確認、未承認コメントの表示、10分間の編集制限を組み合わせることで、ログインを必要としないサイトでも、コメント投稿後の修正に対応できます。
管理者が一つひとつ修正依頼に対応する手間を減らし、投稿者にとっても使いやすいコメント欄にできます。

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