BP_REST_Attachments_Blog_Avatar_Endpoint::get_item_collection_params()
Get the query params for the get_item
.
Description
Return
(array)
Source
File: bp-blogs/classes/class-bp-rest-attachments-blog-avatar-endpoint.php
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | public function get_item_collection_params() { $params = parent::get_collection_params(); $params [ 'context' ][ 'default' ] = 'view' ; // Removing unused params. unset( $params [ 'search' ], $params [ 'page' ], $params [ 'per_page' ] ); $params [ 'html' ] = array ( 'description' => __( 'Whether to return an <img> HTML element, vs a raw URL to an avatar.' , 'buddyboss' ), 'default' => false, 'type' => 'boolean' , 'sanitize_callback' => 'rest_sanitize_boolean' , 'validate_callback' => 'rest_validate_request_arg' , ); $params [ 'alt' ] = array ( 'description' => __( 'The alt attribute for the <img> element.' , 'buddyboss' ), 'default' => '' , 'type' => 'string' , 'sanitize_callback' => 'sanitize_text_field' , 'validate_callback' => 'rest_validate_request_arg' , ); $params [ 'no_user_gravatar' ] = array ( 'description' => __( 'Whether to disable the default Gravatar Admin user fallback.' , 'buddyboss' ), 'default' => false, 'type' => 'boolean' , 'sanitize_callback' => 'rest_sanitize_boolean' , 'validate_callback' => 'rest_validate_request_arg' , ); /** * Filters the item collection query params. * * @param array $params Query params. */ return apply_filters( 'bp_rest_attachments_blog_avatar_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.