関数リファレンス/paginate comments links

この項目「関数リファレンス/paginate comments links」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

現在の投稿について、コメント欄のページネーションリンクを作成します。

基本的にこれは paginate_links() へのマクロであり、コメント欄で動作させるために paginate_links() の機能オプションを設定します。しかし paginate_comments_links() の出力のスタイルを変えるのに、paginate_links() のすべてのパラメータを使用することができます。

使い方

<?php paginate_comments_links( $args ); ?>

パラメータ

$args

（文字列|配列） （オプション） オプションの引数。paginate_links() を参照。

初期値： array()

デフォルト値

• 'base' => add_query_arg( 'cpage', '%#%' ),
• 'format' => ,
• 'total' => $max_page,
• 'current' => $page,
• 'echo' => true,
• 'add_fragment' => '#comments'

参考: 渡された引数は wp_parse_args() を使ってデフォルト値へ結合されます。
これらの引数のほとんどは paginate_links() を呼び出して正しく動作するように選ばれているので、もし変更するときは充分に注意してください。

戻り値

(文字列) 

ページネーションリンクのマークアップを返す。

用例

拡張コメント表示

バージョン 2.7 で WordPress は 拡張コメント表示 /en システムを導入しました。これにより comments.php ファイルの作成と編集がとても容易になりました。その一つはコメントのページ分割を簡単に行う能力で、ページ表示のたびに数百ものコメントがすべて読み込まれるのを待つ羽目になることがなくなりました。

このページングを働かせるには 設定 > ディスカッション設定 で設定する必要があります。

コメントのページングを行う一番簡単な方法は下記の関数を使います。これは次と前のコメントページへのリンクと、すべてのコメントページの番号リストを表示します。

paginate_comments_links( $args );

これは get_posts() や get_terms() に似たクエリ形式の引数リストを受け取ります。

もっと制御したければ、シンプルな next (次)と previous (前)の関数を使うこともできます:

next_comments_link( $label = "", $max_page = 0 );

および

previous_comments_link( $label = "" );

前ページ/次ページリンクのカスタマイズ

前ページと次ページへ進むリンクを変更するには、オプション 'prev_text' と 'next_text' が使えます。これらは関数 paginate_links() が提供します。

paginate_comments_links( 'prev_text=back&next_text=forward' );

'prev_text' や 'next_text' に HTML エンティティを入れたければ、配列形式の構文を使う必要があります。 wp_parse_args() の説明ページに示されているとおりです:

paginate_comments_links( array('prev_text' => '«', 'next_text' => '»') )

参考

• paginate_links() も見てください。
• グローバル: (オブジェクト/tt>) <tt>$wp_query を使用。
• グローバル: (オブジェクト) $wp_rewrite を使用。

変更履歴

新規追加: 2.7.0

ソースファイル

paginate_comments_links() は wp-includes/link-template.php にあります。

関連項目

コメント関数: cancel_comment_reply_link(), comment_author(), comment_author_email(), comment_author_email_link(), comment_author_IP(), comment_author_link(), comment_author_rss(), comment_author_url(), comment_author_url_link(), comment_class(), comment_date(), comment_excerpt(), comment_form_title(), comment_form(), comment_ID(), comment_id_fields() / en, comment_reply_link(), comment_text(), comment_text_rss(), comment_time(), comment_type(), comments_link, comments_number(), comments_open(), comments_popup_link(), comments_popup_script(), comments_rss_link(), get_avatar(), next_comments_link(), paginate_comments_links(), permalink_comments_rss(), previous_comments_link(), wp_list_comments()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/paginate comments links （最新版との差分）