get_the_comments_navigation( array $args = array() )
Retrieves navigation to next/previous set of comments, when applicable.
Description Description
Parameters Parameters
- $args
-
(array) (Optional) Default comments navigation arguments.
- 'prev_text'
(string) Anchor text to display in the previous comments link. Default 'Older comments'. - 'next_text'
(string) Anchor text to display in the next comments link. Default 'Newer comments'. - 'screen_reader_text'
(string) Screen reader text for nav element. Default 'Comments navigation'.
Default value: array()
- 'prev_text'
Return Return
(string) Markup for comments links.
Source Source
File: wp-includes/link-template.php
function get_the_comments_navigation( $args = array() ) { $navigation = ''; // Are there comments to navigate through? if ( get_comment_pages_count() > 1 ) { $args = wp_parse_args( $args, array( 'prev_text' => __( 'Older comments' ), 'next_text' => __( 'Newer comments' ), 'screen_reader_text' => __( 'Comments navigation' ), ) ); $prev_link = get_previous_comments_link( $args['prev_text'] ); $next_link = get_next_comments_link( $args['next_text'] ); if ( $prev_link ) { $navigation .= '<div class="nav-previous">' . $prev_link . '</div>'; } if ( $next_link ) { $navigation .= '<div class="nav-next">' . $next_link . '</div>'; } $navigation = _navigation_markup( $navigation, 'comment-navigation', $args['screen_reader_text'] ); } return $navigation; }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
4.4.0 | Introduced. |