BP_REST_Members_Endpoint::get_collection_params()
Get the query params for collections.
Description
Return
(array)
Source
File: bp-members/classes/class-bp-rest-members-endpoint.php
public function get_collection_params() {
$params = array_intersect_key(
parent::get_collection_params(),
array(
'context' => true,
'page' => true,
'per_page' => true,
'search' => true,
)
);
$params['type'] = array(
'description' => __( 'Shorthand for certain orderby/order combinations.', 'buddyboss' ),
'default' => 'newest',
'type' => 'string',
'enum' => array( 'active', 'newest', 'alphabetical', 'random', 'online', 'popular' ),
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
$params['user_id'] = array(
'description' => __( 'Limit results to friends of a user.', 'buddyboss' ),
'default' => 0,
'type' => 'integer',
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
$params['user_ids'] = array(
'description' => __( 'Pass IDs of users to limit result set.', 'buddyboss' ),
'default' => array(),
'type' => 'array',
'items' => array( 'type' => 'integer' ),
'sanitize_callback' => 'wp_parse_id_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['include'] = array(
'description' => __( 'Ensure result set includes specific IDs.', 'buddyboss' ),
'default' => array(),
'type' => 'array',
'items' => array( 'type' => 'integer' ),
'sanitize_callback' => 'wp_parse_id_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['exclude'] = array(
'description' => __( 'Ensure result set excludes specific IDs.', 'buddyboss' ),
'default' => array(),
'type' => 'array',
'items' => array( 'type' => 'integer' ),
'sanitize_callback' => 'wp_parse_id_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['member_type'] = array(
'description' => __( 'Limit results set to certain type(s).', 'buddyboss' ),
'default' => array(),
'type' => 'array',
'items' => array( 'type' => 'string' ),
'sanitize_callback' => 'bp_rest_sanitize_string_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['xprofile'] = array(
'description' => __( 'Limit results set to a certain xProfile field.', 'buddyboss' ),
'default' => '',
'type' => 'string',
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
$params['bp_ps_search'] = array(
'description' => __( 'Profile Search form field data(s).', 'buddyboss' ),
'default' => array(),
'type' => 'object',
);
$params['scope'] = array(
'description' => __( 'Limit result set to items with a specific scope.', 'buddyboss' ),
'type' => 'string',
'default' => 'all',
'enum' => array( 'all', 'personal', 'following', 'followers' ),
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
);
/**
* Filters the collection query params.
*
* @param array $params Query params.
*/
return apply_filters( 'bp_rest_members_collection_params', $params );
}
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.