Summery Summery
Retrieves a paginated navigation to next/previous set of posts, when applicable.
Syntax Syntax
Parameters Parameters
- $args
-
(Optional) Default pagination arguments, see paginate_links().
- 'screen_reader_text'
(string) Screen reader text for navigation element. Default 'Posts navigation'. - 'aria_label'
(string) ARIA label text for the nav element. Default 'Posts'.
Default value: array()
- 'screen_reader_text'
Return Return
(string) Markup for pagination links.
Source Source
File: wp-includes/link-template.php
* Optional. Default pagination arguments, see paginate_links().
*
* @type string $screen_reader_text Screen reader text for navigation element.
* Default 'Posts navigation'.
* @type string $aria_label ARIA label text for the nav element. Default 'Posts'.
* @type string $class Custom class for the nav element. Default 'pagination'.
* }
* @return string Markup for pagination links.
*/
function get_the_posts_pagination( $args = array() ) {
$navigation = '';
// Don't print empty markup if there's only one page.
if ( $GLOBALS['wp_query']->max_num_pages > 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(
'mid_size' => 1,
'prev_text' => _x( 'Previous', 'previous set of posts' ),
'next_text' => _x( 'Next', 'next set of posts' ),
'screen_reader_text' => __( 'Posts navigation' ),
'aria_label' => __( 'Posts' ),
'class' => 'pagination',
)
);
// Make sure we get a string back. Plain is the next best thing.
if ( isset( $args['type'] ) && 'array' === $args['type'] ) {
$args['type'] = 'plain';
}
Advertisement
Changelog Changelog
| Version | Description |
|---|---|
| 5.3.0 | Added the aria_label parameter. |
| 4.1.0 | Introduced. |