Contents

Code Reference Functions bp_rest_response_add_total_headers()

bp_rest_response_add_total_headers( WP_REST_Response $response, integer $total, integer $per_page )

Set headers to let the Client Script be aware of the pagination.

Description

Parameters

$response

(Required) The response data.

$total

(Required) The total number of found items.

$per_page

(Required) The number of items per page of results.

Return

(WP_REST_Response) $response The response data.

Source

File: bp-core/bp-core-rest-api.php

160
161
162
163
164
165
166
167
168
169
170
171
172
function bp_rest_response_add_total_headers( WP_REST_Response $response, $total = 0, $per_page = 0 ) {
    if ( ! $total || ! $per_page ) {
        return $response;
    }
 
    $total_items = (int) $total;
    $max_pages   = ceil( $total_items / (int) $per_page );
 
    $response->header( 'X-WP-Total', $total_items );
    $response->header( 'X-WP-TotalPages', (int) $max_pages );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyBoss 1.3.5 Introduced.
Used By
Used By Description
bp-document/classes/class-bp-rest-document-folder-endpoint.php: BP_REST_Document_Folder_Endpoint::get_items()

Retrieve document folders.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::get_items()

Retrieve documents.
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::get_items()

Retrieve threads.
bp-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::get_items()

Retrieve signups.
bp-members/classes/class-bp-rest-members-endpoint.php: BP_REST_Members_Endpoint::get_items()

Retrieve users.
bp-media/classes/class-bp-rest-media-endpoint.php: BP_REST_Media_Endpoint::get_items()

Retrieve medias.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::get_items()

Retrieve Albums.
bp-invites/classes/class-bp-rest-invites-endpoint.php: BP_REST_Invites_Endpoint::get_items()

Sent Invites.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::get_items()

Retrieve groups.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::get_items()

Retrieve group members.
bp-groups/classes/class-bp-rest-group-membership-request-endpoint.php: BP_REST_Group_Membership_Request_Endpoint::get_items()

Fetch pending group membership requests.
bp-groups/classes/class-bp-rest-group-invites-endpoint.php: BP_REST_Group_Invites_Endpoint::get_items()

Retrieve group invitations.
bp-friends/classes/class-bp-rest-friends-endpoint.php: BP_REST_Friends_Endpoint::get_items()

Retrieve friendships.
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::dropdown_items()

Topic’s Dropdown
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::get_items()

Retrieve Topics.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::get_items()

Retrieve Replies.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::get_items()

Retrieve Forums.
bp-integrations/learndash/classes/class-bp-rest-learndash-courses-endpoint.php: BP_REST_Learndash_Courses_Endpoint::get_items()

Retrieve courses.
bp-core/classes/class-bp-rest-components-endpoint.php: BP_REST_Components_Endpoint::get_items()

Retrieve components.
bp-blogs/classes/class-bp-rest-blogs-endpoint.php: BP_REST_Blogs_Endpoint::get_items()

Retrieve Blogs.
bp-activity/classes/class-bp-rest-activity-endpoint.php: BP_REST_Activity_Endpoint::get_items()

Retrieve activities.
Show 16 more used by Hide more used by

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.