BP_REST_Activity_Comment_Endpoint::get_collection_params()
Get the query params for collections of plugins.
Description
Return
(array)
Source
File: bp-activity/classes/class-bp-rest-activity-comment-endpoint.php
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | public function get_collection_params() { $params = parent::get_collection_params(); $params['context']['default'] = 'view'; // Removing unused params. unset( $params['search'], $params['page'], $params['per_page'] ); $params['id'] = array( 'description' => __( 'A unique numeric ID for the activity.', 'buddyboss' ), 'type' => 'integer', 'reqiured' => true, ); $params['display_comments'] = array( 'description' => __( 'Comments by default, stream for within stream display, threaded for below each activity item.', 'buddyboss' ), 'default' => 'threaded', 'enum' => array( 'stream', 'threaded' ), 'type' => 'string', 'sanitize_callback' => 'sanitize_key', 'validate_callback' => 'rest_validate_request_arg', ); /** * Filters the collection query params. * * @param array $params Query params. */ return apply_filters( 'bp_rest_activity_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.