bp_get_group_member_pagination_count()

Get total number of group member pages and total number of group members.

Description

Return

(mixed|void)

Source

function bp_get_group_member_pagination_count() {
    global $members_template;
 
    $start_num = intval( ( $members_template->pag_page - 1 ) * $members_template->pag_num ) + 1;
    $from_num  = bp_core_number_format( $start_num );
    $to_num    = bp_core_number_format( ( $start_num + ( $members_template->pag_num - 1 ) > $members_template->total_member_count ) ? $members_template->total_member_count : $start_num + ( $members_template->pag_num - 1 ) );
    $total     = bp_core_number_format( $members_template->total_member_count );
 
    $message = sprintf( _n( 'Viewing 1 member', 'Viewing %1$s - %2$s of %3$s members', $members_template->total_member_count, 'buddyboss' ), $from_num, $to_num, $total );
 
    /**
     * Filters the "Viewing x-y of z members" pagination message.
     *
     * @since BuddyPress 1.0.0
     *
     * @param string $value    "Viewing x-y of z members" text.
     * @param string $from_num Total amount for the low value in the range.
     * @param string $to_num   Total amount for the high value in the range.
     * @param string $total    Total amount of members found.
     */
    return apply_filters( 'bp_get_group_member_pagination_count', $message, $from_num, $to_num, $total );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_get_group_member_pagination_count	Filters the “Viewing x-y of z members” pagination message.
bp-core/bp-core-functions.php: bp_core_number_format()	Format numbers the BuddyPress way.

Used By
Used By	Description
bp-groups/bp-groups-template.php: bp_group_member_pagination_count()	Output total number of group member pages and total number of group members.

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