bbp_get_forum_index_pagination_count()

Return the forum index pagination count

Description

Return

(string) Forum Pagintion count

Source

function bbp_get_forum_index_pagination_count() {
    $bbp = bbpress();
 
    if ( empty( $bbp->forum_query ) )
        return false;
 
    // Set pagination values
    $start_num = intval( ( $bbp->forum_query->paged - 1 ) * $bbp->forum_query->posts_per_page ) + 1;
    $from_num  = bbp_number_format( $start_num );
    $to_num    = bbp_number_format( ( $start_num + ( $bbp->forum_query->posts_per_page - 1 ) > $bbp->forum_query->found_posts ) ? $bbp->forum_query->found_posts : $start_num + ( $bbp->forum_query->posts_per_page - 1 ) );
    $total_int = (int) !empty( $bbp->forum_query->found_posts ) ? $bbp->forum_query->found_posts : $bbp->forum_query->post_count;
    $total     = bbp_number_format( $total_int );
 
    // Several forums in a forum index with a single page
    if ( empty( $to_num ) ) {
        $retstr = sprintf( _n( 'Viewing %1$s forum', 'Viewing %1$s forums', $total_int, 'buddyboss' ), $total );
 
        // Several forums in a forum index with several pages
    } else {
        $retstr = sprintf( _n( 'Viewing %2$s of %4$s forums', 'Viewing %2$s - %3$s of %4$s forums', $total_int, 'buddyboss' ), $bbp->forum_query->post_count, $from_num, $to_num, $total );
    }
 
    // Filter and return
    return apply_filters( 'bbp_get_forum_index_pagination_count', esc_html( $retstr ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2519)	Introduced.

Uses

Uses
Uses	Description
bp-forums/classes/class-bbpress.php: bbpress()	The main function responsible for returning the one true bbPress Instance to functions everywhere.
bp-forums/common/functions.php: bbp_number_format()	A Forums specific method of formatting numeric values

Used By
Used By	Description
bp-forums/forums/template.php: bbp_forum_index_pagination_count()	Forum Pagination *********************************************************

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents