BP_REST_Friends_Endpoint::get_items( WP_REST_Request $request )
Retrieve friendships.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-friends/classes/class-bp-rest-friends-endpoint.php
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 195 196 197 198 199 200 201 202 203 204 205 | public function get_items( $request ) { $args = array( 'id' => $request->get_param( 'id' ), 'initiator_user_id' => $request->get_param( 'initiator_id' ), 'friend_user_id' => $request->get_param( 'friend_id' ), 'is_confirmed' => $request->get_param( 'is_confirmed' ), 'order_by' => $request->get_param( 'order_by' ), 'sort_order' => strtoupper( $request->get_param( 'order' ) ), 'page' => $request->get_param( 'page' ), 'per_page' => $request->get_param( 'per_page' ), ); /** * 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_friends_get_items_query_args', $args, $request ); // null is the default values. foreach ( $args as $key => $value ) { if ( empty( $value ) && 'is_confirmed' !== $key ) { $args[ $key ] = null; } } // Check if user is valid. $user = get_user_by( 'id', $request->get_param( 'user_id' ) ); if ( ! $user instanceof WP_User ) { return new WP_Error( 'bp_rest_friends_get_items_user_failed', __( 'There was a problem confirming if user is valid.', 'buddyboss' ), array( 'status' => 500, ) ); } // Actually, query it. $friendships = BP_Friends_Friendship::get_friendships( $user->ID, $args ); $retval = array(); foreach ( (array) $friendships as $friendship ) { $retval[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $friendship, $request ) ); } $response = rest_ensure_response( $retval ); $response = bp_rest_response_add_total_headers( $response, count( $friendships ), $args['per_page'] ); /** * Fires after friendships are fetched via the REST API. * * @param array $friendships Fetched friendships. * @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_friends_get_items', $friendships, $response, $request ); return $response;} |
Changelog
| Version | Description |
|---|---|
| 0.1.0 | Introduced. |
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.