BP_REST_Signup_Endpoint::get_items( WP_REST_Request $request )
Retrieve signups.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-members/classes/class-bp-rest-signup-endpoint.php
public function get_items( $request ) {
$args = array(
'include' => $request['include'],
'order' => $request['order'],
'orderby' => $request['orderby'],
'user_login' => $request['user_login'],
'number' => $request['number'],
'offset' => $request['offset'],
);
if ( empty( $request['include'] ) ) {
$args['include'] = 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_signup_get_items_query_args', $args, $request );
// Actually, query it.
$signups = BP_Signup::get( $args );
$retval = array();
foreach ( $signups['signups'] as $signup ) {
$retval[] = $this->prepare_response_for_collection(
$this->prepare_item_for_response( $signup, $request )
);
}
$response = rest_ensure_response( $retval );
$response = bp_rest_response_add_total_headers( $response, $signups['total'], $args['number'] );
/**
* Fires after a list of signups is fetched via the REST API.
*
* @param array $signups Fetched signups.
* @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_signup_get_items', $signups, $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.