Contents

Code Reference Classes BP_REST_Media_Albums_Endpoint BP_REST_Media_Albums_Endpoint::get_items()

BP_REST_Media_Albums_Endpoint::get_items( WP_REST_Request $request )

Retrieve Albums.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-media/classes/class-bp-rest-media-albums-endpoint.php

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
public function get_items( $request ) {
    $args = array(
        'page'        => $request['page'],
        'per_page'    => $request['per_page'],
        'sort'        => $request['order'],
        'order_by'    => $request['orderby'],
        'count_total' => $request['count_total'],
        'fields'      => 'all',
    );
 
    if ( ! empty( $request['search'] ) ) {
        $args['search_terms'] = $request['search'];
    }
 
    if ( ! empty( $request['max'] ) ) {
        $args['max'] = $request['max'];
    }
 
    if ( ! empty( $request['user_id'] ) ) {
        $args['user_id'] = $request['user_id'];
    }
 
    if ( ! empty( $request['group_id'] ) ) {
        $args['group_id'] = $request['group_id'];
    }
 
    if ( ! empty( $request['privacy'] ) ) {
        $args['privacy'] = $request['privacy'];
    }
 
    if ( ! empty( $request['exclude'] ) ) {
        $args['exclude'] = $request['exclude'];
    }
 
    if ( ! empty( $request['include'] ) ) {
        $args['album_ids'] = $request['include'];
    }
 
    /**
     * Filter the query arguments for the request.
     *
     * @param array           $args    Key value array of query var to query value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    $args = apply_filters( 'bp_rest_media_albums_get_items_query_args', $args, $request );
 
    $medias = $this->assemble_response_data( $args );
 
    $retval = array();
    foreach ( $medias['albums'] as $album ) {
        $retval[] = $this->prepare_response_for_collection(
            $this->prepare_item_for_response( $album, $request )
        );
    }
 
    $response = rest_ensure_response( $retval );
    $response = bp_rest_response_add_total_headers( $response, $medias['total'], $args['per_page'] );
 
    /**
     * Fires after a list of members is fetched via the REST API.
     *
     * @param array            $media    Fetched Media Albums.
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request  $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_media_albums_get_items', $medias, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-media/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::assemble_response_data()

Get Albums.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::prepare_item_for_response()

Prepares activity data for return as an object.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: bp_rest_media_albums_get_items_query_args

Filter the query arguments for the request.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: bp_rest_media_albums_get_items

Fires after a list of members is fetched via the REST API.
bp-core/bp-core-rest-api.php: bp_rest_response_add_total_headers()

Set headers to let the Client Script be aware of the pagination.
bp-friends/bp-friends-functions.php: friends_check_friendship()

Check whether two users are friends.
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.
bp-core/bp-core-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
Show 3 more uses Hide more uses

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.