Summery Summery
Retrieves navigation to next/previous set of comments, when applicable.
Syntax Syntax
Parameters Parameters
- $args
-
(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 the nav element. Default 'Comments navigation'. - 'aria_label'
(string) ARIA label text for the nav element. Default 'Comments'.
Default value: array()
- 'prev_text'
Return Return
(string) Markup for comments links.
Source Source
File: wp-includes/link-template.php
* @since 5.5.0 Added the `class` parameter.
*
* @param array $args {
* Optional. Default comments navigation arguments.
*
* @type string $prev_text Anchor text to display in the previous comments link.
* Default 'Older comments'.
* @type string $next_text Anchor text to display in the next comments link.
* Default 'Newer comments'.
* @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'.
* @type string $aria_label ARIA label text for the nav element. Default 'Comments'.
* @type string $class Custom class for the nav element. Default 'comment-navigation'.
* }
* @return string Markup for comments links.
*/
function get_the_comments_navigation( $args = array() ) {
$navigation = '';
// Are there comments to navigate through?
if ( get_comment_pages_count() > 1 ) {
// Make sure the nav element has an aria-label attribute: fallback to the screen reader text.
if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) {
$args['aria_label'] = $args['screen_reader_text'];
}
$args = wp_parse_args(
$args,
array(
'prev_text' => __( 'Older comments' ),
'next_text' => __( 'Newer comments' ),
'screen_reader_text' => __( 'Comments navigation' ),
'aria_label' => __( 'Comments' ),
'class' => 'comment-navigation',
)
);
Advertisement
Changelog Changelog
| Version | Description |
|---|---|
| 5.3.0 | Added the aria_label parameter. |
| 4.4.0 | Introduced. |