BP_REST_Media_Endpoint::bp_rest_message_query_arguments( array $params )

Filter Query argument for the Messages for media support.

Description

Parameters

$params

(array) (Required) Query arguments.

Return

(array)

Source

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

	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.