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

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

「関数リファレンス/paginate comments links」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(一部訳)
(残りを和訳。クリーンアップ。)
 
1行目: 1行目:
 +
{{CheckTrans}}
 +
 +
<div id="Description">
 
== 説明 ==
 
== 説明 ==
現在のコメント欄のページネーションリンクを作成します。
+
</div>
 +
 
 +
現在の投稿について、コメント欄のページネーションリンクを作成します。
  
基本的にこれは[[関数リファレンス/paginate_links | paginate_links()]] へのマクロがあり、コメント欄で動作させるために、<tt>paginate_links()</tt>の関数オプションを設定します。
+
基本的にこれは [[関数リファレンス/paginate_links | paginate_links()]] へのマクロであり、コメント欄で動作させるために <tt>paginate_links()</tt> の機能オプションを設定します。しかし <tt>paginate_comments_links()</tt> の出力のスタイルを変えるのに、<tt>paginate_links()</tt> のすべてのパラメータを使用することができます。
しかし、<tt>paginate_comments_links()</tt>の出力をスタイルするのに、<tt>paginate_links()</tt>にすべてのパラメータを使用することができます。
+
  
 +
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 +
</div>
  
  <?php paginate_comments_links( $args ) ?>
+
  <?php paginate_comments_links( $args ); ?>
  
 +
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 +
</div>
  
{{Parameter|$args|string&#124;array|オプションの引数。 [[関数リファレンス/paginate_links|paginate_links()]]を参照。|オプション|array}}
+
{{Parameter|$args|文字列&#124;配列|オプションの引数。[[関数リファレンス/paginate_links|paginate_links()]] を参照。|オプション|<code>array()</code>}}
  
=== デフォルトの使い方 ===
+
<div id="Defaults">
 +
== デフォルト値 ==
 +
</div>
  
 
<tt>
 
<tt>
23行目: 33行目:
 
* 'add_fragment' => '#comments'
 
* 'add_fragment' => '#comments'
 
</tt>
 
</tt>
 +
''参考:'' 渡された引数は [[関数リファレンス/wp_parse_args|wp_parse_args()]] を使ってデフォルト値へ結合されます。<br />
 +
これらの引数のほとんどは <tt>paginate_links()</tt> を呼び出して正しく動作するように選ばれているので、もし変更するときは充分に注意してください。
  
''注:'' Arguments passed in are merged to the defaults, via [[関数リファレンス/wp_parse_args|wp_parse_args]].<br />
+
<div id="Return_Values">
These arguments are mostly to make the call of <tt>paginate_links()</tt> work, so be careful if you change them.
+
== 戻り値 ==
 +
</div>
  
==戻り値 ==
+
; (文字列) : ページネーションリンクのマークアップを返す。
; (string) : ページネーションリンクのマークアップを返す。
+
  
 +
<div id="Examples">
 
== 用例 ==
 
== 用例 ==
 +
</div>
  
=== Enhanced Comment Display ===
+
<div id="Enhanced_Comment_Display">
In version 2.7 WordPress added the [[Migrating Plugins and Themes to 2.7/Enhanced Comment Display | 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.
+
=== 拡張コメント表示 ===
 +
</div>
  
You will need to set up the options in SETTINGS > DISCUSSION for paging to work.
+
バージョン 2.7 で WordPress は [[Migrating Plugins and Themes to 2.7/Enhanced Comment Display | 拡張コメント表示]] /[[:en:Migrating Plugins and Themes to 2.7/Enhanced Comment Display|en]] システムを導入しました。これにより comments.php ファイルの作成と編集がとても容易になりました。その一つはコメントのページ分割を簡単に行う能力で、ページ表示のたびに数百ものコメントがすべて読み込まれるのを待つ羽目になることがなくなりました。
  
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 <tt>get_posts()</tt> or <tt>get_terms()</tt>.
+
paginate_comments_links( $args );
  
If you want more control, you can also use the simpler next and previous functions:
+
これは <tt>get_posts()</tt> や <tt>get_terms()</tt> に似たクエリ形式の引数リストを受け取ります。
  
next_comments_link($label="", $max_page = 0)
+
もっと制御したければ、シンプルな next ()と previous ()の関数を使うこともできます:
and
+
previous_comments_link($label="")
+
  
=== 戻る-/次へ-リンクのカスタム ===
+
next_comments_link( $label = "", $max_page = 0 );
 +
および
 +
previous_comments_link( $label = "" );
 +
 
 +
<div id="Custom_Prev-.2FNext-links">
 +
=== 前ページ/次ページリンクのカスタマイズ ===
 +
</div>
 +
 
 +
前ページと次ページへ進むリンクを変更するには、オプション <code>'prev_text'</code> と <code>'next_text'</code> が使えます。これらは関数 [[関数リファレンス/paginate_links | paginate_links()]] が提供します。
 +
 
 +
paginate_comments_links( 'prev_text=back&next_text=forward' );
 +
 
 +
<code>'prev_text'</code> や <code>'next_text'</code> に HTML エンティティを入れたければ、配列形式の構文を使う必要があります。[[関数リファレンス/wp_parse_args | wp_parse_args()]] の説明ページに示されているとおりです:
  
To modify the Prev- and Next-links, you can use the options 'prev_text' and 'next_text'. These are provided by the function [[Function_Reference/paginate_links | 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 [[Function_Reference/wp_parse_args | wp_parse_args()]]-page:
 
 
  paginate_comments_links( array('prev_text' => '&amp;laquo;', 'next_text' => '&amp;raquo;') )
 
  paginate_comments_links( array('prev_text' => '&amp;laquo;', 'next_text' => '&amp;raquo;') )
  
 
<!-- Need creative examples. Feel free to link to external examples. -->
 
<!-- Need creative examples. Feel free to link to external examples. -->
  
== ==
+
<div id="Notes">
* 合わせて見る: [[関数リファレンス/paginate_links|<tt>paginate_links()</tt>]]
+
== 参考 ==
* Uses global: (<tt>object</tt>) [[Class_Reference/WP_Query|<tt>$wp_query</tt>]]
+
</div>
* Uses global: (<tt>object</tt>) <tt>$wp_rewrite</tt>
+
 
 +
* [[関数リファレンス/paginate_links|<tt>paginate_links()</tt>]] も見てください。
 +
* グローバル: (<tt>オブジェクト/tt>) [[Class_Reference/WP_Query|<tt>$wp_query</tt>]] を使用。
 +
* グローバル: (<tt>オブジェクト</tt>) <tt>$wp_rewrite</tt> を使用。
 +
 
 +
<div id="Change_Log">
 +
== 変更履歴 ==
 +
</div>
  
== 更新履歴 ==
 
 
新規追加: 2.7.0
 
新規追加: 2.7.0
  
 +
<div id="Source_File">
 
== ソースファイル ==
 
== ソースファイル ==
<!-- Need links to current source code files -->
+
</div>
<tt>paginate_comments_links()</tt>は {{Trac|wp-includes/link-template.php}}にあります。
+
  
== 関連 ==
+
<tt>paginate_comments_links()</tt> は {{Trac|wp-includes/link-template.php}} にあります。
<!--
+
    To Do:
+
    Need to find related functions.
+
    Need to create groups of functions and create templates to add them to a page quickly.
+
    Some functions may be related to many groups of functions.
+
-->
+
  
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
 
{{Tag Comments Tags}}
 
{{Tag Comments Tags}}
83行目: 108行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
{{NeedTrans}}
+
{{原文|Function Reference/paginate comments links|151871}} <!-- 05:40, 30 May 2015 Miccweb 版 -->
 
+
{{原文|Function Reference/paginate comments links|115767}}<!-- 13:23, 11 April 2012‎ Jdesrosiers  版 -->
+
  
 
{{DEFAULTSORT:Paginate_comments_links}}
 
{{DEFAULTSORT:Paginate_comments_links}}
 +
[[Category:関数]]
 +
 +
[[en:Function Reference/paginate comments links]]

2016年5月4日 (水) 00:16時点における最新版

この項目「関数リファレンス/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' => '&laquo;', 'next_text' => '&raquo;') )


参考

  • 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最新版との差分