BP_REST_Groups_Details_Endpoint::get_collection_params()

Get the query params for collections of plugins.

Description

Return

(array)

Source

File: bp-groups/classes/class-bp-rest-groups-details-endpoint.php

	public function get_collection_params() {
		$params = array(
			'type' => array(
				'description'       => __( 'Filter by.. active(Last Active), popular(Most Members), newest(Newly Created), alphabetical(Alphabetical)', 'buddyboss' ),
				'type'              => 'string',
				'enum'              => array( 'active', 'popular', 'newest', 'alphabetical' ),
				'validate_callback' => 'rest_validate_request_arg',
			),
		);

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

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/classes/class-bp-rest-groups-details-endpoint.php: bp_rest_groups_details_collection_params	Filters the collection query params.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-groups-details-endpoint.php: BP_REST_Groups_Details_Endpoint::register_routes()	Register the component routes.

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.

Contents