REST_Submission_Values_Controller::get_collection_params()

Retrieves the query params for the models collection.

Description

Return

(array) Collection parameters.

Source

File: src/db-objects/submission-values/rest-submission-values-controller.php

	public function get_collection_params() {
		$query_params = parent::get_collection_params();

		$query_params['per_page']['maximum'] = 500;

		$query_params['form_id'] = array(
			'description' => __( 'Limit result set to submission values associated with a specific form ID.', 'torro-forms' ),
			'type'        => 'integer',
			'minimum'     => 1,
		);

		$query_params['submission_id'] = array(
			'description' => __( 'Limit result set to submission values associated with a specific submission ID.', 'torro-forms' ),
			'type'        => 'integer',
			'minimum'     => 1,
		);

		$query_params['element_id'] = array(
			'description' => __( 'Limit result set to submission values referring to a specific element ID.', 'torro-forms' ),
			'type'        => 'integer',
			'minimum'     => 1,
		);

		return $query_params;
	}

Changelog

Changelog
Version Description
1.0.0 Introduced.