BP_REST_Group_Membership_Request_Endpoint::get_collection_params()

Get the query params for collections of group invites.


Return Return

(array)


Source Source

File: bp-groups/classes/class-bp-rest-group-membership-request-endpoint.php

	public function get_collection_params() {
		$params                       = $this->invites_endpoint->get_collection_params();
		$params['context']['default'] = 'view';

		// Adapt some item schema property descriptions to this endpoint.
		$params['user_id']['description']  = __( 'Return only Membership requests made by a specific user.', 'buddypress' );
		$params['group_id']['description'] = __( 'The ID of the group the user requested a membership for.', 'buddypress' );

		// Remove unused properties.
		unset( $params['invite_sent'], $params['inviter_id'] );

		/**
		 * Filters the collection query params.
		 *
		 * @param array $params Query params.
		 */
		return apply_filters( 'bp_rest_group_membership_requests_collection_params', $params );
	}


Top ↑

Changelog Changelog

Changelog
Version Description
5.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.