get_the_comments_navigation

The timeline below displays how wordpress function get_the_comments_navigation has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 5.5

/**
 * Retrieves navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
 * @since 5.3.0 Added the `aria_label` parameter.
 * @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'));
        $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, $args['class'], $args['screen_reader_text'], $args['aria_label']);
    }
    return $navigation;
}

WordPress Version: 5.3

/**
 * Retrieves navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
 * @since 5.3.0 Added the `aria_label` 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'.
 * }
 * @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')));
        $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'], $args['aria_label']);
    }
    return $navigation;
}

WordPress Version: 4.6

/**
 * Retrieves navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
 *
 * @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 nav element. Default 'Comments 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) {
        $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;
}

WordPress Version: 4.4

/**
 * Returns navigation to next/previous set of comments when applicable.
 *
 * @since 4.4.0
 *
 * @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 nav element. Default 'Comments 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) {
        $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;
}