Descrição
Replaces the plain ← Older Comments | Newer Comments → links with numbered page links.
Example: Page 1 of 20: [1] 2 3 4 ... Last
It is the comment-thread counterpart of WP-PageNavi, and the two are deliberately built the same way, down to the names of the filters that change the class names.
The plugin icon is by Freepik from Flaticon.
Features
- Numbered page links instead of two prev/next links
- A drop-down list style, for threads with a great many pages
- Every piece of the navigation’s text is configurable, including inline SVG arrows
- Larger page numbers — 10, 20, 30 — for jumping across a long thread
- Ten filters for the element class names, one for the finished markup
- One stylesheet that serves both left-to-right and right-to-left locales, restyled with two CSS custom properties
Donations
I spent most of my free time creating, updating, maintaining and supporting these plugins, if you really love my plugins and could spare me a couple of bucks, I will really appreciate it. If not feel free to use it without any obligations.
Usage
The template tag reads figures that WordPress only populates inside comments_template(), so it belongs in comments.php and produces nothing anywhere else.
It also accepts an array of arguments:
<?php
wp_commentnavi(
array(
'wrapper_tag' => 'nav',
'wrapper_class' => 'my-comment-nav',
'options' => array( 'num_pages' => 3 ),
)
);
?>
Pass 'echo' => false to get the markup back as a string instead of printing it.
Changing the CSS
The navigation inherits its font and its colours from your theme, and the two colours it does set are CSS custom properties, so the usual way to restyle it is to set those in your theme’s style.css:
:root {
--wp-commentnavi-border-color: #d0d0d0;
--wp-commentnavi-border-color-current: #c0392b;
}
If you need to change more than that, copy css/wp-commentnavi.css out of the plugin directory into your theme’s directory as wp-commentnavi.css and edit it there. Your changes then survive plugin updates, and a copy in a child theme wins over one in the parent theme.
Alternatively, set Use wp-commentnavi.css to No on the settings screen and write the styles yourself.
Changing Class Names
These filters change the class names assigned to the navigation elements:
wp_commentnavi_class_pageswp_commentnavi_class_firstwp_commentnavi_class_previouscommentslinkwp_commentnavi_class_extendwp_commentnavi_class_smallerwp_commentnavi_class_pagewp_commentnavi_class_currentwp_commentnavi_class_largerwp_commentnavi_class_nextcommentslinkwp_commentnavi_class_last
Other Filters
wp_commentnavi— the complete markup, before it is printedwp_commentnavi_allowed_html— the tags allowed inside the navigation text settingswp_commentnavi_capability— the capability required to reach the settings screen,manage_optionsby default
add_filter( 'wp_commentnavi_capability', function ( $capability, $context ) {
return 'edit_pages';
}, 10, 2 );
Capturas de tela
Instalação
- Install and activate the plugin.
- Open
wp-content/themes/<YOUR THEME NAME>/comments.phpand add<?php if ( function_exists( 'wp_commentnavi' ) ) { wp_commentnavi(); } ?>where the old comment links were. - Go to
WP-Admin -> Settings -> CommentNavito configure it.
The tag reads figures WordPress only populates inside comments_template(), so it belongs in comments.php and nowhere else.
Perguntas frequentes
-
That function was removed in 2.0.0, along with the
comment-allquery variable it depended on. Openwp-content/themes/<YOUR THEME NAME>/comments.phpand delete the line that calls it.It was removed because the query variable was not guarded. Any visitor could append
?comment-all=1to any URL on the site and force WordPress to load up to 9999 comments in a single query, on every request, with no rate limiting — the hook ran onpre_get_postswithout checkingis_main_query()or evenis_singular().If you want to keep offering a way to read every comment at once, raise Number Of Pages To Show, or set the comment paging options under Settings -> Discussion to suit.
-
Where did the settings page go?
-
It is at Settings -> CommentNavi, which is now
options-general.php?page=wp-commentnavi.The old address was
options-general.php?page=wp-commentnavi/commentnavi-options.php, which had the plugin’s directory name inside it. Anyone who installed the plugin under a different directory name — a rename, a deploy tool, a bundled copy — got a settings screen that could not be opened at all. -
Rename it to
wp-commentnavi.css. The plugin’s own stylesheet moved tocss/wp-commentnavi.cssin 2.0.0, and the file it looks for in your theme was renamed to match, so the file you copy and the file you copied it from are spelled the same way. -
The stylesheet no longer sets a link colour, a border colour or a white background. It inherits your theme’s colours instead, which is what lets it fit a dark theme without being told anything about one. Set
--wp-commentnavi-border-colorand--wp-commentnavi-border-color-currentin your theme to restyle it, as described above. -
That is fixed in 2.0.0.
wp_kses_post(), which the settings screen used to filter with, deletes an<svg>element rather than cleaning it. That left the link text empty, and a link with no text is dropped altogether — so the whole link vanished, not just the icon.The navigation text is now filtered against
wp_kses_post()‘s list plus the inline SVG elements. Use thewp_commentnavi_allowed_htmlfilter to adjust that list. -
Those are larger page numbers, and they are off by default, so upgrading will not have caused this. Set Number Of Larger Page Numbers To Show to
0under Settings -> CommentNavi to turn them off. -
Nothing renders at all
-
wp_commentnavi() reads
$wp_query->max_num_comment_pages, which WordPress only sets insidecomments_template(). Call it from your theme’scomments.php, not fromsingle.php, a sidebar or a widget.Also check that Break comments into pages is enabled under Settings -> Discussion. With comment paging off there is only ever one page, and the navigation hides itself unless Always Show Comment Navigation is set to Yes.
Avaliações
Colaboradores e desenvolvedores
“WP-CommentNavi” é um programa de código aberto. As seguintes pessoas contribuíram para este plugin.
Colaboradores
WP-CommentNavi” foi traduzido para 2 localidades. Agradecemos aos tradutores por suas contribuições.
Traduzir o “WP-CommentNavi” para seu idioma.
Interessado no desenvolvimento?
Navegue pelo código, consulte o repositório SVN ou assine o registro de desenvolvimento por RSS.
Registro de alterações
2.0.0
- BREAKING: Requires WordPress 6.8 and PHP 8.2, up from 6.0 and 7.4.
- BREAKING: The “View all comments” feature has been removed — the
comment-allquery variable andwp_commentnavi_all_comments_link(). It hookedpre_get_postswith nois_main_query()oris_singular()guard and forcedcomments_per_pageto 9999, so any visitor could trigger an unbounded comment query on any URL. If your theme callswp_commentnavi_all_comments_link()you must remove that call. See the FAQ - BREAKING: The settings page moved to Settings -> CommentNavi at
options-general.php?page=wp-commentnavi. The old address embedded the plugin’s directory name, which made the screen unreachable for anyone who had installed the plugin under a different one. Update your bookmarks - BREAKING: The settings are stored in
wp_commentnavi_optionsinstead ofcommentnavi_options, and the plugin and schema versions in awp_commentnavi_versionrow of their own. Your settings are carried across automatically the first time wp-admin is loaded after updating - BREAKING:
commentnavi-css.cssis nowcss/wp-commentnavi.css, and a copy in your theme has to be renamed towp-commentnavi.cssto keep being used - NEW: Restructured into
includes/following the Plugin Handbook layout. The plugin is now five classes behind the same template tags - NEW: The settings page is built with the WordPress Settings API
- NEW: Larger page numbers, as in WP-PageNavi. Off by default, so upgrading does not change how your comment navigation looks — set Number Of Larger Page Numbers To Show to turn it on
- NEW: A Use wp-commentnavi.css setting, so the stylesheet can be turned off without editing anything
- NEW: Ten
wp_commentnavi_class_*filters for the element class names, awp_commentnavifilter for the whole markup, andwp_commentnavi_allowed_htmlfor the tags permitted in the navigation text - NEW: A
wp_commentnavi_capabilityfilter, so the settings screen can be handed to a capability other thanmanage_options - NEW:
wp_commentnavi()accepts an array of arguments, including'echo' => falseto return the markup instead of printing it - CHANGED: The stylesheet sets no link colour, border colour or background of its own. It inherits the theme’s colours, and the two it does need come from the
--wp-commentnavi-border-colorand--wp-commentnavi-border-color-currentcustom properties, with a dark-scheme default - CHANGED: The stylesheet is written with direction-neutral CSS, so one sheet serves both writing directions
- FIXED: Network activation and multisite uninstall were fatal errors. Both called
wp_get_sites(), which WordPress removed in 5.1 - FIXED: Multisite uninstall stopped at the hundredth site, leaving the settings behind everywhere after it, and restored the current blog once instead of once per site
- FIXED: XSS. The first, last and numbered links put the navigation text straight into a
titleattribute with no escaping, so a double quote in a setting closed the attribute and everything after it became markup - FIXED: An option row saved by an older version raised a PHP notice on the front end for every setting added since. Defaults are now merged on read
- FIXED: The “Text For Previous …” box displayed the “Text For Next …” value, so the two could never be given different text through the settings screen
- FIXED: Saving the settings added a backslash before every apostrophe, visibly, on the site itself.
addslashes()was applied on top of the slashes WordPress already adds to$_POST - FIXED: A
commentnavi-css.cssin your theme was looked for in the parent theme but loaded from the child theme, so under a child theme neither location worked - FIXED: The plugin directory name was hardcoded, so the stylesheet 404d if the plugin was installed under any other directory name
- FIXED: A post with no comments reported “Page 1 of 0” when Always Show Comment Navigation was on
- FIXED: The drop-down style pointed its form at an admin URL, and
case 2;used a semicolon, which PHP 8.5 deprecates - FIXED: The stylesheet is enqueued on
wp_enqueue_scriptsrather thanwp_print_styles, and its version tracks the plugin version instead of being pinned to 1.10 - NOTE: Four settings labels were renamed from “Text For First/Last/Next/Previous Comment” to “… Page”, because those links go to a page of comments rather than to a comment. Renaming a string resets it on translate.wordpress.org, so those four labels will show in English in translated locales until someone retranslates them. Every other existing label kept its original wording precisely to avoid that