Cocoonでカテゴリー別にコメントフォーム・コメント欄を非表示にする方法

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

拡張:カテゴリー一覧から不要なカテゴリーを非表示する方法

Cocoonの場合は、Cocoonのコメント欄表示設定を利用し、機能を拡張してカテゴリー一覧画面に「表示/非表示」の切り替えボタンを設置します。
これにより、カテゴリーごとにコメント欄の表示・非表示を設定できるようになります。

完成イメージ

実装手順

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

/**
 * コメント欄を非表示にするカテゴリーとその子孫カテゴリーのID一覧を取得
 *
 * @return int[] 非表示対象となるカテゴリーIDの配列
 */
if (!function_exists('my_get_hidden_comment_category_ids')):
function my_get_hidden_comment_category_ids() {
  // 非表示フラグが設定されたカテゴリーIDを取得
  $hidden_terms = get_terms([
    'taxonomy'   => 'category',
    'hide_empty' => false,
    'meta_query' => [
      [
        'key'     => 'my_hide_comment_section',
        'value'   => '1',
        'compare' => '=',
      ],
    ],
    'fields' => 'ids',
  ]);

  // 非表示カテゴリーが存在しない場合は空の配列を返して終了
  if (is_wp_error($hidden_terms) || empty($hidden_terms)) {
    return [];
  }

  $exclude_ids = [];

  foreach ($hidden_terms as $term_id) {
    // 非表示カテゴリー自身のIDを登録
    $exclude_ids[] = (int) $term_id;

    // 子孫カテゴリーのIDを取得
    $children = get_term_children((int) $term_id, 'category');

    // 子孫カテゴリーが存在する場合は除外対象に追加
    if (!is_wp_error($children) && !empty($children)) {
      $exclude_ids = array_merge($exclude_ids, array_map('intval', $children));
    }
  }

  // 重複するカテゴリーIDを除去して返却
  return array_values(array_unique($exclude_ids));
}
endif;


// 管理画面一覧にカラムを追加
add_filter('manage_edit-category_columns', function ($columns) {
  $columns['comment_visibility'] = 'コメント欄';

  return $columns;
});


// 管理画面一覧のカラムにデータを表示
add_filter('manage_category_custom_column', function ($value, $column_name, $term_id) {
  if ('comment_visibility' !== $column_name) {
    return $value;
  }

  // 非表示カテゴリーとその子孫のIDを取得
  $hidden_ids = my_get_hidden_comment_category_ids();

  // 対象カテゴリーの非表示状態を判定
  $is_hidden = in_array((int) $term_id, $hidden_ids, true);

  // 非表示状態に応じてCSSクラスを設定
  $btn_class = $is_hidden ? 'comment-vis-btn is-hidden' : 'comment-vis-btn is-visible';
  $btn_text  = $is_hidden ? '非表示' : '表示中';

  return '<button type="button" class="button button-small ' . esc_attr($btn_class) . '" data-term-id="' . esc_attr($term_id) . '">' . esc_html($btn_text) . '</button>';
}, 10, 3);


// 管理画面用JS・CSSを追加
add_action('admin_enqueue_scripts', function ($hook_suffix) {
  if ($hook_suffix !== 'edit-tags.php') {
    return;
  }

  // 現在の画面情報を取得
  $screen = get_current_screen();

  if (!$screen || $screen->taxonomy !== 'category') {
    return;
  }

  // ボタンのデザインを設定
  ob_start();
  ?>
  .comment-vis-btn {
    &.is-visible {
      border-color: #00a32a !important;
      color: #00a32a !important;
    }

    &.is-hidden {
      border-color: #d63638 !important;
      color: #d63638 !important;
    }
  }
  <?php
  wp_add_inline_style('wp-admin', ob_get_clean());

  $handle = 'comment-visibility-admin';
  wp_register_script($handle, '');
  wp_enqueue_script($handle);

  wp_localize_script($handle, 'commentVisData', [
    'ajaxurl' => admin_url('admin-ajax.php'),
    'comment_visibility_nonce' => wp_create_nonce('comment_visibility_action'),
  ]);

  // ボタンクリック時のAjax処理を設定
  ob_start();
  ?>
  jQuery(document).ready(function($) {
    $(document).on('click', '.comment-vis-btn', function() {
      var $btn = $(this);
      var termId = $btn.data('term-id');

      // 処理中はボタンを無効化
      $btn.prop('disabled', true);

      $.ajax({
        url: commentVisData.ajaxurl,
        type: 'POST',
        data: {
          action: 'toggle_comment_visibility_btn',
          term_id: termId,
          comment_visibility_nonce: commentVisData.comment_visibility_nonce
        },
        success: function(response) {
          $btn.prop('disabled', false);

          // 更新成功時は一覧を再読み込み
          if (response.success) {
            window.location.reload();
          } else {
            alert(response.data || '更新に失敗しました。');
          }
        },
        error: function() {
          // 通信エラー時はボタンを有効化
          $btn.prop('disabled', false);
          alert('通信エラーが発生しました。');
        }
      });
    });
  });
  <?php
  wp_add_inline_script($handle, ob_get_clean());
});


// Ajaxアクションを追加
add_action('wp_ajax_toggle_comment_visibility_btn', function () {
  if (!isset($_POST['term_id'], $_POST['comment_visibility_nonce'])) {
    wp_send_json_error('不正なリクエストです。');
  }

  // nonceチェック
  if (!wp_verify_nonce($_POST['comment_visibility_nonce'], 'comment_visibility_action')) {
    wp_send_json_error('セキュリティチェックに失敗しました。');
  }

  // 権限チェック
  if (!current_user_can('manage_categories')) {
    wp_send_json_error('権限がありません。');
  }

  // リクエストからカテゴリーIDを取得
  $term_id = absint($_POST['term_id']);

  // 対象カテゴリーの情報を取得
  $term = get_term($term_id, 'category');

  if (!$term || is_wp_error($term)) {
    wp_send_json_error('カテゴリーが見つかりません。');
  }

  // 現在の非表示フラグを取得
  $current_hidden = get_term_meta($term_id, 'my_hide_comment_section', true);

  if ($current_hidden === '1') {
    delete_term_meta($term_id, 'my_hide_comment_section');
    $new_hidden = '';
  } else {
    update_term_meta($term_id, 'my_hide_comment_section', '1');
    $new_hidden = '1';
  }

  // 更新結果を返す
  wp_send_json_success(['is_hidden' => $new_hidden]);
});


// Cocoon設定(投稿)のコメントを表示を変更
add_filter('theme_mod_single_comment_visible', function ($visible) {
  if (!is_single()) {
    return $visible;
  }

  // 現在の投稿IDを取得
  $post_id = get_queried_object_id();

  if (!$post_id) {
    return $visible;
  }

  // 非表示カテゴリーとその子孫のIDを取得
  $hidden_ids = my_get_hidden_comment_category_ids();

  // 投稿が非表示対象のカテゴリーに属する場合はコメント欄を非表示
  if (!empty($hidden_ids) && has_category($hidden_ids, $post_id)) {
    return false;
  }

  return $visible;
});

さいごに

今回紹介した方法を使えば、カテゴリーごとにコメントフォームやコメント欄全体の表示を制御できます。WordPress標準のフックを利用する方法に加え、Cocoon独自の設定を利用する方法も紹介しました。
さらに、カテゴリー一覧画面から表示・非表示を切り替えられるようにすれば、コードを変更することなく管理できます。
サイトの運用に合わせて、使いやすい方法を取り入れてみてください。

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