概要
get_next_comments_link
関数は、特定の投稿に対するコメントの次ページへのリンクを取得するための関数です。この関数は、多くのコメントが投稿されている場合に、コメントのページネーションを実装する際に便利です。以下は、この関数がよく使われる機能の例です。
- コメント一覧のページネーションを実装する
- コメントが多すぎて一ページに収まらない場合のナビゲーションを提供する
- ユーザーエクスペリエンスを向上させるための簡易的なナビゲーションリンクを表示する
- 特定のページに対するコメント数を把握する
- コメントの表示を管理するためのカスタマイズを行う
- コメントの表示順序を制御する
- コメントがすでに読まれたかどうかをユーザーに示す
- カスタムテーマでのデザインの一環として利用する
構文
get_next_comments_link( $label = null, $page = 0 )
パラメータ
$label
(string|null) – 次のコメントリンクに表示するテキスト。デフォルトは「Next」。省略可能。$page
(int) – リンク先のページ番号。デフォルトは次のページ。
戻り値
- 文字列: HTML形式で構築された次のコメントリンク。次のページがなければ
null
を返します。
関連する関数
使用可能なバージョン
get_next_comments_link
関数は、WordPress バージョン 2.7 以降で使用可能です。
コアファイルのパス
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 ( get_next_comments_link() ) {
echo get_next_comments_link( '次のコメント' );
}
このコードは、次のコメントページへのリンクが存在する場合に「次のコメント」というテキストでリンクを表示します。
引用元: https://developer.wordpress.org/reference/functions/get_next_comments_link/
サンプルコード 2: ページ番号を指定した使用例
echo get_next_comments_link( '次のページ', 2 );
このコードは、ページ番号 2 にリンクする「次のページ」というテキストのリンクを表示します。
引用元: https://developer.wordpress.org/reference/functions/get_next_comments_link/
サンプルコード 3: コメント数の確認とリンクの表示
if ( get_comments_number() > 10 ) {
echo get_next_comments_link();
}
このコードは、コメント数が10件を超える場合に次のコメントリンクを表示します。
引用元: https://developer.wordpress.org/reference/functions/get_next_comments_link/
サンプルコード 4: ユーザー定義のラベルを使用
$next_link = get_next_comments_link( 'もっとコメントを見る' );
if ( $next_link ) {
echo $next_link;
}
このコードは、次のコメントリンクに「もっとコメントを見る」というカスタムテキストを使用して表示します。
引用元: https://developer.wordpress.org/reference/functions/get_next_comments_link/
サンプルコード 5: HTML形式での出力
if ( $next_link = get_next_comments_link() ) {
printf( '<div class="comment-navigation">%s</div>', $next_link );
}
このコードは、次のコメントリンクを <div>
タグ内でHTML形式で出力します。
引用元: https://developer.wordpress.org/reference/functions/get_next_comments_link/