BP_REST_Blogs_Endpoint::get_collection_params()
Get the query params for blogs collections.
Description
Return
(array)
Source
File: bp-blogs/classes/class-bp-rest-blogs-endpoint.php
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 | public function get_collection_params() { $params = parent::get_collection_params(); $params['context']['default'] = 'view'; $params['user_id'] = array( 'description' => __( 'ID of the user whose blogs user can post to.', 'buddyboss' ), 'default' => 0, 'type' => 'integer', 'sanitize_callback' => 'absint', '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['type'] = array( 'description' => __( 'Limit result set to items with a specific type.', 'buddyboss' ), 'default' => 'active', 'type' => 'string', 'enum' => array( 'active', 'alphabetical', 'newest', 'random' ), '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_blogs_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.