概要
previous_comments_link 関数は、前のコメント一覧のリンクを表示するために使用されます。この関数は主に、コメントが多数寄せられた投稿やページにおいてユーザーが過去のコメントを簡単に確認できるようにするインターフェースを提供します。以下は、この関数がよく使用されるシナリオの例です：
- コメントが多い記事のナビゲーション。
- コメントページネーションの実装。
- デザインの一部としての前のコメントへのリンク。
- 特定の投稿に対してのユーザビリティ向上。
- コメントセクションのカスタマイズにおける役割。
- 複数ページに分かれたコメントの管理。
- ユーザーエンゲージメントを高めるためのナビゲーション提供。
- コミュニティフォーラムなどのインタラクティブなページにおける利用。
構文
previous_comments_link( $label = null, $max_page = 0 );
パラメータ
$label(string): 表示するリンクのテキスト。デフォルトは “Previous Comments”。$max_page(int): コメントの最大ページ数。デフォルトは 0。
戻り値
この関数は、リンクが生成された場合にはその HTML を返しますが、リンクがない場合は false を返します。
関連する関数
使用可能なバージョン
previous_comments_link 関数は、WordPress バージョン 1.5 以降で使用可能です。
コアファイルのパス
この関数は、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 ( ! pagenum_link() && have_comments() ) {
previous_comments_link( '前のコメント' );
}
このコードは、コメントが存在する場合のみ、前のコメント一覧のリンクを表示します。
サンプルコード 2
if ( is_single() ) {
echo '<div class="comments-navigation">';
previous_comments_link( '古いコメントを表示' );
echo '</div>';
}
このコードは、シングル投稿ページにおいて、古いコメントを表示するリンクを挿入します。
サンプルコード 3
$comments_per_page = 5;
$page = get_query_var( 'cpage' ) ? get_query_var( 'cpage' ) : 1;
if ( $page > 1 ) {
previous_comments_link( '前のページのコメント' );
}
このコードは、コメントページが 1 より大きい場合に前のページのコメントリストへのリンクを表示します。
サンプルコード 4
if ( have_comments() ) {
echo '<nav class="comment-navigation">';
previous_comments_link( '前のコメント' );
next_comments_link( '次のコメント' );
echo '</nav>';
}
このコードは、ユーザーがコメントの前後を切り替えられるナビゲーションを表示します。
サンプルコード 5
echo '<div class="comments-pagination">';
previous_comments_link( '前のコメント' );
echo '</div>';
このコードは、コメントのページネーションとして、前のコメントリンクを表示します。