ワードプレスのthe_comments_navigation関数の使用方法・解説

概要

the_comments_navigation 関数は、コメントセクションにおいて複数ページにわたるコメントをナビゲートするためのリンクを表示する機能を提供します。主に以下のようなシナリオで使用されます。

1. Blogやニュースサイトでコメントが多い投稿において。
2. フォーラムでのディスカッションが活発な場合。
3. コメントの返信が多く、ページが長くなる投稿。
4. 記事に対するフィードバックを探す際の利便性向上。
5. コメントの評価や投票機能を使用している場合。
6. コメントセクションを整然と見せたい場合。
7. ユーザー体験を向上させるためにナビゲーションが必要な場合。
8. 投稿ごとにコメント数が異なる場合。

この関数は特に、コメントが多く投稿がページ分割される際に便利です。

構文

the_comments_navigation( $args );

パラメータ

• $args (配列): ナビゲーションリンクをカスタマイズするための引数（省略可能）。

戻り値

特に値を返すわけではなく、HTMLを出力します。

関連する関数

• get_comments_number
• paginate_comments_links

使用可能なバージョン

この関数は WooCommerce 1.0 以降で使用可能です。

コアファイルのパス

wp-includes/comment-template.php

この関数のアクションでの使用可能性

アクション	使用例
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

1. 基本的な使用例

   if ( have_comments() ) {
      the_comments_navigation();
   }
   

   コメントが存在する場合、コメントナビゲーションを表示します。

2. カスタムナビゲーション

   if ( have_comments() ) {
      the_comments_navigation( array(
          'prev_text' => __('前のコメント'),
          'next_text' => __('次のコメント'),
      ) );
   }
   

   ナビゲーションのテキストをカスタマイズして表示します。

3. 条件付きナビゲーション表示

   if ( get_comments_number() > 5 ) {
      the_comments_navigation();
   }
   

   コメント数が5を超える場合のみナビゲーションを表示します。

4. ナビゲーション後にコメント表示

   if ( have_comments() ) {
      the_comments_navigation();
      wp_list_comments();
   }
   

   まずナビゲーションを表示し、その後にコメントのリストを表示します。

5. 特定のコメントタイプをナビゲート

   if ( have_comments() ) {
      the_comments_navigation( array( 'type' => 'comment' ) );
   }
   

   特定のコメントタイプに基づいてナビゲーションを表示します。

これらのサンプルコードはすべて著作権フリーであり、独自のプロジェクトに適用することができます。