get_the_comments_pagination()


WordPressのget_the_comments_pagination()関数は、コメントのページネーションを取得するために使用されます。この関数は、コメントのページネーションをHTML形式で返します。

構文

get_the_comments_pagination( array $args = array() );
  • $args(array) — ページネーションの設定を配列で指定します。デフォルトは空の配列です。

使用可能な引数:

  • 'prev_text'(string) — 「前へ」リンクのテキストを指定します。
  • 'next_text'(string) — 「次へ」リンクのテキストを指定します。
  • 'screen_reader_text'(string) — スクリーンリーダー用のテキストを指定します。
  • 'aria_label'(string) — ページネーションのARIAラベルを指定します。
  • 'class'(string) — ページネーションのクラスを指定します。

例1: 基本的なコメントページネーションの表示

この例では、デフォルトの設定でコメントのページネーションを表示します。

<?php echo get_the_comments_pagination(); ?>

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

「前へ」と「次へ」のテキストをカスタマイズして表示します。

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

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

スクリーンリーダー用のテキストを変更して表示します。

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

例4: ARIAラベルの追加

ARIAラベルを追加して、アクセシビリティを向上させます。

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

例5: カスタムクラスの追加

ページネーションにカスタムクラスを追加します。

<?php echo get_the_comments_pagination( array( 'class' => 'custom-pagination-class' ) ); ?>

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

すべての引数を組み合わせて、完全にカスタマイズされたページネーションを表示します。

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

例7: 現在の投稿のコメントページネーションを表示

現在の投稿のコメントページネーションを表示します。

<?php if ( comments_open() || get_comments_number() ) { comments_template(); echo get_the_comments_pagination(); } ?>

例8: コメントページネーションを条件付きで表示

コメントが存在する場合にのみ、ページネーションを表示します。

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

注意点:

  • この関数は、コメントがページネーションを必要とする場合にのみ使用してください。
  • スクリーンリーダー用のテキストやARIAラベルを適切に設定することで、アクセシビリティを向上させることができます。

関連機能：