get_the_posts_pagination( array $args = array() )
Retrieves a paginated navigation to next/previous set of posts, when applicable.
Parameters
- $args
-
(Optional) Default pagination arguments, see paginate_links().
- 'screen_reader_text'
(string) Screen reader text for navigation element. Default 'Posts navigation'.
Default value: array()
- 'screen_reader_text'
Return
(string) Markup for pagination links.
Source
File: wp-includes/link-template.php
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 ) {
$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' ),
) );
// Make sure we get a string back. Plain is the next best thing.
if ( isset( $args['type'] ) && 'array' == $args['type'] ) {
$args['type'] = 'plain';
}
// Set up paginated links.
$links = paginate_links( $args );
if ( $links ) {
$navigation = _navigation_markup( $links, 'pagination', $args['screen_reader_text'] );
}
}
return $navigation;
}
Changelog
Version | Description |
---|---|
WP-4.1.0 | Introduced. |