Function Reference/paginate comments links

来自WordPress中文文档
跳转至: 导航搜索

Description

Create pagination links for the comments on the current post.

Basically this is a macro to paginate_links() which sets the functional options of paginate_links() to make it work for comments. But you may use all the parameters of paginate_links() to style the output of paginate_comments_links().

Usage

%%%<?php paginate_comments_links( $args ) ?>%%%

Parameters

tt$args/tt
(string|array) (optional) Optional args. See paginate_links().
Default: arraynoinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

Defaults

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

Note: 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.

Return Values

(string) 
Markup for pagination links.

Examples

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="")

Custom Prev-/Next-links

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;') )


Notes

Change Log

Since: 2.7.0

Source File

paginate_comments_links() is located in onlyincludecodewp-includes/link-template.php/code/onlyinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Template Description

Link to the source code on http://core.trac.wordpress.org/browser/.

Parameters

  1. filename
  2. (option) path to codetag/code (version) or codetrunk/code. This option is only used for a new function.br /Default: codetrunk/code -- trunk is the latest bleeding edge development version of WordPress.

Usage

Link to the stable version: pre检查到模板循环:模板:Trac/pre

Link to trunk: pre检查到模板循环:模板:Trac/pre

/div

wordpress.org.cn.

Related

includeonlydiv style=clear:both; background-color:#F7F7F7; border:1px solid #CCCCCC; color:#000000; padding:7px; margin:0.5em auto 0.5em auto; vertical-align:middle;See also index of Function Reference and index of Template Tags./div/includeonlynoinclude

Description

This Template is used by Codex:Template Messages.

Usage

pre 检查到模板循环:模板:Message /pre

Result

检查到模板循环:模板:Message

/noinclude