BP_REST_Media_Endpoint::bp_rest_message_query_arguments( array $params )

Filter Query argument for the Messages for media support.

Description

Parameters

$params

(Required) Query arguments.

Return

(array)

Source

File: bp-media/classes/class-bp-rest-media-endpoint.php

2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
public function bp_rest_message_query_arguments( $params ) {
 
    if ( function_exists( 'bp_is_messages_media_support_enabled' ) && true === bp_is_messages_media_support_enabled() ) {
        $params['bp_media_ids'] = array(
            'description'       => __( 'Media specific IDs.', 'buddyboss' ),
            'default'           => array(),
            'type'              => 'array',
            'items'             => array( 'type' => 'integer' ),
            'sanitize_callback' => 'wp_parse_id_list',
            'validate_callback' => 'rest_validate_request_arg',
        );
    }
 
    if ( function_exists( 'bp_is_messages_gif_support_enabled' ) && true === bp_is_messages_gif_support_enabled() ) {
        $params['media_gif'] = array(
            'description' => __( 'Save gif data into topic.', 'buddyboss' ),
            'type'        => 'object',
            'items'       => array( 'type' => 'string' ),
            'default'     => array(
                'url' => '',
                'mp4' => '',
            ),
            'properties'  => array(
                'url' => array(
                    'description'       => __( 'URL for the gif media from object `480w_still->url`', 'buddyboss' ),
                    'type'              => 'string',
                    'required'          => true,
                    'sanitize_callback' => 'sanitize_key',
                    'validate_callback' => 'rest_validate_request_arg',
                ),
                'mp4' => array(
                    'description'       => __( 'Gif file URL from object `original_mp4->mp4`', 'buddyboss' ),
                    'required'          => true,
                    'type'              => 'string',
                    'sanitize_callback' => 'sanitize_key',
                    'validate_callback' => 'rest_validate_request_arg',
                ),
            ),
        );
    }
 
    return $params;
}

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.