bbp_get_search_pagination_count()

Return the search results pagination count

Description

Return

(string) Search pagination count

Source

function bbp_get_search_pagination_count() {
    $bbp = bbpress();
 
    // Define local variable(s)
    $retstr = '';
 
    // Set pagination values
    $start_num = intval( ( $bbp->search_query->paged - 1 ) * $bbp->search_query->posts_per_page ) + 1;
    $from_num  = bbp_number_format( $start_num );
    $to_num    = bbp_number_format( ( $start_num + ( $bbp->search_query->posts_per_page - 1 ) > $bbp->search_query->found_posts ) ? $bbp->search_query->found_posts : $start_num + ( $bbp->search_query->posts_per_page - 1 ) );
    $total_int = (int) $bbp->search_query->found_posts;
    $total     = bbp_number_format( $total_int );
 
    // Single page of results
    if ( empty( $to_num ) ) {
        $retstr = sprintf( _n( 'Viewing %1$s result', 'Viewing %1$s results', $total_int, 'buddyboss' ), $total );
 
    // Several pages of results
    } else {
        $retstr = sprintf( _n( 'Viewing %2$s of %4$s results', 'Viewing %2$s - %3$s of %4$s results', $bbp->search_query->post_count, 'buddyboss' ), $bbp->search_query->post_count, $from_num, $to_num, $total );
 
    }
 
    // Filter and return
    return apply_filters( 'bbp_get_search_pagination_count', esc_html( $retstr ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r4579)	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/search/template.php: bbp_search_pagination_count()	Output the search result pagination count

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