get_the_comments_pagination

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

WordPress Version: 5.5

/**
 * Retrieves a paginated 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.
 *
 * @see paginate_comments_links()
 *
 * @param array $args {
 *     Optional. Default pagination arguments.
 *
 *     @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 'comments-pagination'.
 * }
 * @return string Markup for pagination links.
 */
function get_the_comments_pagination($args = array())
{
    $navigation = '';
    // 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('screen_reader_text' => __('Comments navigation'), 'aria_label' => __('Comments'), 'class' => 'comments-pagination'));
    $args['echo'] = false;
    // Make sure we get a string back. Plain is the next best thing.
    if (isset($args['type']) && 'array' === $args['type']) {
        $args['type'] = 'plain';
    }
    $links = paginate_comments_links($args);
    if ($links) {
        $navigation = _navigation_markup($links, $args['class'], $args['screen_reader_text'], $args['aria_label']);
    }
    return $navigation;
}

WordPress Version: 5.3

/**
 * Retrieves a paginated navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
 * @since 5.3.0 Added the `aria_label` parameter.
 *
 * @see paginate_comments_links()
 *
 * @param array $args {
 *     Optional. Default pagination arguments.
 *
 *     @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 pagination links.
 */
function get_the_comments_pagination($args = array())
{
    $navigation = '';
    // 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('screen_reader_text' => __('Comments navigation'), 'aria_label' => __('Comments')));
    $args['echo'] = false;
    // Make sure we get a string back. Plain is the next best thing.
    if (isset($args['type']) && 'array' == $args['type']) {
        $args['type'] = 'plain';
    }
    $links = paginate_comments_links($args);
    if ($links) {
        $navigation = _navigation_markup($links, 'comments-pagination', $args['screen_reader_text'], $args['aria_label']);
    }
    return $navigation;
}

WordPress Version: 4.9

/**
 * Retrieves a paginated navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
 *
 * @see paginate_comments_links()
 *
 * @param array $args {
 *     Optional. Default pagination arguments.
 *
 *     @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
 * }
 * @return string Markup for pagination links.
 */
function get_the_comments_pagination($args = array())
{
    $navigation = '';
    $args = wp_parse_args($args, array('screen_reader_text' => __('Comments navigation')));
    $args['echo'] = false;
    // Make sure we get a string back. Plain is the next best thing.
    if (isset($args['type']) && 'array' == $args['type']) {
        $args['type'] = 'plain';
    }
    $links = paginate_comments_links($args);
    if ($links) {
        $navigation = _navigation_markup($links, 'comments-pagination', $args['screen_reader_text']);
    }
    return $navigation;
}

WordPress Version: 4.6

/**
 * Retrieves a paginated navigation to next/previous set of comments, when applicable.
 *
 * @since 4.4.0
 *
 * @see paginate_comments_links()
 *
 * @param array $args {
 *     Optional. Default pagination arguments.
 *
 *     @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
 * }
 * @return string Markup for pagination links.
 */
function get_the_comments_pagination($args = array())
{
    $navigation = '';
    $args = wp_parse_args($args, array('screen_reader_text' => __('Comments navigation')));
    $args['echo'] = false;
    // Make sure we get plain links, so we get a string we can work with.
    $args['type'] = 'plain';
    $links = paginate_comments_links($args);
    if ($links) {
        $navigation = _navigation_markup($links, 'comments-pagination', $args['screen_reader_text']);
    }
    return $navigation;
}

WordPress Version: 4.4

/**
 * Returns a paginated navigation to next/previous set of comments,
 * when applicable.
 *
 * @since 4.4.0
 *
 * @see paginate_comments_links()
 *
 * @param array $args {
 *     Optional. Default pagination arguments.
 *
 *     @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
 * }
 * @return string Markup for pagination links.
 */
function get_the_comments_pagination($args = array())
{
    $navigation = '';
    $args = wp_parse_args($args, array('screen_reader_text' => __('Comments navigation')));
    $args['echo'] = false;
    // Make sure we get plain links, so we get a string we can work with.
    $args['type'] = 'plain';
    $links = paginate_comments_links($args);
    if ($links) {
        $navigation = _navigation_markup($links, 'comments-pagination', $args['screen_reader_text']);
    }
    return $navigation;
}