BP_REST_Notifications_Endpoint::get_items( WP_REST_Request $request )
Retrieve notifications.
Description
Parameters
- $request
-
(WP_REST_Request) (Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-notifications/classes/class-bp-rest-notifications-endpoint.php
public function get_items( $request ) { $args = array( 'user_id' => $request['user_id'], 'item_id' => $request['item_id'], 'secondary_item_id' => $request['secondary_item_id'], 'component_name' => $request['component_name'], 'component_action' => $request['component_action'], 'order_by' => $request['order_by'], 'sort_order' => strtoupper( $request['sort_order'] ), 'is_new' => $request['is_new'], 'page' => $request['page'], 'per_page' => $request['per_page'], ); if ( empty( $request['component_action'] ) ) { $args['component_action'] = false; } if ( empty( $request['component_name'] ) ) { $args['component_name'] = false; } /** * 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_notifications_get_items_query_args', $args, $request ); // Actually, query it. $notifications = BP_Notifications_Notification::get( $args ); $retval = array(); foreach ( $notifications as $notification ) { $retval[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $notification, $request ) ); } $response = rest_ensure_response( $retval ); /** * Fires after notifications are fetched via the REST API. * * @param array $notifications Fetched notifications. * @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_notifications_get_items', $notifications, $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.