get_the_comments_navigation()


WordPressのget_the_comments_navigation()関数は、コメントのナビゲーションリンクを取得するために使用されます。この関数は、コメントのページネーションを表示する際に役立ちます。

構文

get_the_comments_navigation( array $args = array() );

引数の説明:

  • $args(array) — ナビゲーションリンクの設定を配列で指定します。デフォルトは空の配列です。
  • 'prev_text'(string) — 「前へ」リンクのテキストを指定します。
  • 'next_text'(string) — 「次へ」リンクのテキストを指定します。
  • 'screen_reader_text'(string) — スクリーンリーダー用のテキストを指定します。
  • 'aria_label'(string) — ナビゲーションのARIAラベルを指定します。
  • 'class'(string) — ナビゲーションのCSSクラスを指定します。

例1: 基本的なコメントナビゲーションの表示

これは、コメントのナビゲーションリンクを表示する基本的な例です。

<?php echo get_the_comments_navigation(); ?>

例2: 「前へ」と「次へ」のテキストを変更

「前へ」と「次へ」のテキストをカスタマイズする例です。

<?php echo get_the_comments_navigation( array( 'prev_text' => '前のコメント', 'next_text' => '次のコメント' ) ); ?>

例3: スクリーンリーダーテキストの変更

スクリーンリーダー用のテキストを変更する例です。

<?php echo get_the_comments_navigation( array( 'screen_reader_text' => 'コメントナビゲーション' ) ); ?>

例4: ARIAラベルの追加

ナビゲーションにARIAラベルを追加する例です。

<?php echo get_the_comments_navigation( array( 'aria_label' => 'コメントページネーション' ) ); ?>

例5: CSSクラスの追加

ナビゲーションにCSSクラスを追加する例です。

<?php echo get_the_comments_navigation( array( 'class' => 'comment-navigation' ) ); ?>

例6: 全ての引数を組み合わせる

全ての引数を組み合わせて使用する例です。

<?php echo get_the_comments_navigation( array( 'prev_text' => '前のコメント', 'next_text' => '次のコメント', 'screen_reader_text' => 'コメントナビゲーション', 'aria_label' => 'コメントページネーション', 'class' => 'comment-navigation' ) ); ?>

例7: コメントナビゲーションを条件付きで表示

コメントが存在する場合にのみナビゲーションを表示する例です。

<?php if ( get_comment_pages_count() > 1 ) { echo get_the_comments_navigation(); } ?>

例8: カスタムクエリを使用したコメントナビゲーション

カスタムクエリを使用してコメントナビゲーションを表示する例です。

<?php $comments_query = new WP_Comment_Query( array( 'post_id' => get_the_ID() ) ); if ( $comments_query->max_num_pages > 1 ) { echo get_the_comments_navigation(); } ?>

注意点:

  • この関数は、コメントのページネーションが有効な場合にのみ機能します。
  • 引数を指定しない場合、デフォルトの設定が適用されます。
  • スクリーンリーダー用のテキストは、アクセシビリティを向上させるために重要です。

関連機能：