get_the_posts_pagination

Retrieves a paginated navigation to next/previous set of posts, when applicable.

Description

(string) get_the_posts_pagination( (array) $args = array() );

Returns (string)

Markup for pagination links.

Parameters (1)

0. $args — Optional. (array) => array()

Default pagination arguments, see paginate_links(…).

Options

List
Code
Close

…

Usage

if ( !function_exists( 'get_the_posts_pagination' ) ) { 
    require_once ABSPATH . WPINC . '/link-template.php'; 
} 
  
// Optional. Default pagination arguments, see paginate_links(). 
$args = array(); 
  
// NOTICE! Understand what this does before running. 
$result = get_the_posts_pagination($args);

Defined (1)

The function is defined in the following location(s).

/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; 
}