• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

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

提供: WordPress Codex 日本語版
< 関数リファレンス
2015年6月15日 (月) 15:39時点におけるMiccweb (トーク | 投稿記録)による版 (一部訳)

移動先: 案内検索

説明

現在のコメント欄のページネーションリンクを作成します。

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

使い方

<?php paginate_comments_links( $args ) ?>

パラメータ

$args
string|array) (オプション) オプションの引数。 paginate_links()を参照。
初期値: array

デフォルトの使い方

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

注: Arguments passed in are merged to the defaults, via wp_parse_args.
These arguments are mostly to make the call of paginate_links() work, so be careful if you change them.

戻り値

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

用例

Enhanced Comment Display

In version 2.7 WordPress added the Enhanced Comment Display system to make comments.php files much simpler to write and edit. One is the ability to easily break comments into pages so that you don't end up with hundreds of comments all loading on every pageview.

You will need to set up the options in SETTINGS > DISCUSSION for paging to work.

The easiest way to do so is with the following function, which prints out a link to the next and previous comment pages, as well as a numbered list of all the comment pages.

paginate_comments_links($args);

It accepts a query-style list of arguments similar to get_posts() or get_terms().

If you want more control, you can also use the simpler next and previous functions:

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

and

previous_comments_link($label="")

戻る-/次へ-リンクのカスタム

To modify the Prev- and Next-links, you can use the options 'prev_text' and 'next_text'. These are provided by the function paginate_links().

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

If you want to use HTML entities in your 'prev_text' or 'next_text', you will have to use the array-based syntax, as it is descriped on the wp_parse_args()-page:

paginate_comments_links( array('prev_text' => '&laquo;', 'next_text' => '&raquo;') )


更新履歴

新規追加: 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()



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


このページ「関数リファレンス/paginate comments links」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

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