Summery Summery
Retrieves a paginated navigation to next/previous set of comments, when applicable.
Syntax Syntax
Parameters Parameters
- $args
-
(Optional) Default pagination arguments.
- '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()
- 'screen_reader_text'
Return Return
(string) Markup for pagination links.
Source Source
File: wp-includes/link-template.php
/** * 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' ),
Advertisement
Changelog Changelog
Version | Description |
---|---|
5.3.0 | Added the aria_label parameter. |
4.4.0 | Introduced. |