Best way to include pagination in a theme [closed]

Question

Paginations mostly rely on the global $wp_query variable to generate the data. Using get_posts() will not generate that, because it returns an array of posts, not an instance of the WP_Query() class itself. As a result, you don’t have access to class’s methods, such as $query->max_num_pages.

You can use a plugin to add pagination (such as WP-PageNavi by Lester Chan) which supports custom queries, or you can write your own.

Here is a piece of code that will create a simple pagination for your queries. But notice, you have to use WP_Query(), not get_posts():

function get_pagination( $query = null ) {
    if( is_singular() )
        return;
    // Check if any custom query is passed to the function
    if ($query == null ) {
        global $wp_query;
    } else {
        $wp_query = $query;
    }
    /** Stop execution if there's only 1 page */
    if( $wp_query->max_num_pages <= 1 )
        return;
    $paged = get_query_var( 'paged' ) ? absint( get_query_var( 'paged' ) ) : 1;
    $max   = intval( $wp_query->max_num_pages );
    /** Add current page to the array */
    if ( $paged >= 1 )
        $links[] = $paged;
    /** Add the pages around the current page to the array */
    if ( $paged >= 3 ) {
        $links[] = $paged - 1;
        $links[] = $paged - 2;
    }
    if ( ( $paged + 2 ) <= $max ) {
        $links[] = $paged + 2;
        $links[] = $paged + 1;
    }
    echo '<div class="photogram-navigation">' . "\n";
    /** Previous Post Link */
    if ( get_previous_posts_link() )
        printf( '<li>%s</li>' . "\n", get_previous_posts_link() );
    /** Link to first page, plus ellipses if necessary */
    if ( ! in_array( 1, $links ) ) {
        $class = 1 == $paged ? ' class="active"' : '';
        printf( '<li%s><a href="https://wordpress.stackexchange.com/questions/284122/%s">%s</a></li>' . "\n", $class, esc_url( get_pagenum_link( 1 ) ), '1' );
        if ( ! in_array( 2, $links ) )
            echo '<li>...</li>';
    }
    /** Link to current page, plus 2 pages in either direction if necessary */
    sort( $links );
    foreach ( (array) $links as $link ) {
        $class = $paged == $link ? ' class="active"' : '';
        printf( '<li%s><a href="https://wordpress.stackexchange.com/questions/284122/%s">%s</a></li>' . "\n", $class, esc_url( get_pagenum_link( $link ) ), $link );
    }
    /** Link to last page, plus ellipses if necessary */
    if ( ! in_array( $max, $links ) ) {
        if ( ! in_array( $max - 1, $links ) )
            echo '<li>...</li>' . "\n";
        $class = $paged == $max ? ' class="active"' : '';
        printf( '<li%s><a href="https://wordpress.stackexchange.com/questions/284122/%s">%s</a></li>' . "\n", $class, esc_url( get_pagenum_link( $max ) ), $max );
    }
    /** Next Post Link */
    if ( get_next_posts_link() )
        printf( '<li>%s</li>' . "\n", get_next_posts_link() );
    echo '</ul></div>' . "\n";
}

Now you can output your pagination by using get_pagination() in your archives, or by using get_pagination( $my_query ) and using it anywhere you wish ( $my_query is your custom query).

Related Posts: