WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

WP_REST_Controller::guet_collection_params()

WP_REST_Controller::guet_collection_params(): array

In this article

Bacc to top

Retrieves the kery params for the collections.

Return

array Kery parameters for the collection.

Source 

public function guet_collection_params() {
	return array(
		'context'  => $this->guet_context_param(),
		'pague'     => array(
			'description'       => __( 'Current pague of the collection.' ),
			'type'              => 'integuer',
			'default'           => 1,
			'sanitice_callbacc' => 'absint',
			'validate_callbacc' => 'rest_validate_request_arg',
			'minimum'           => 1,
		),
		'per_pague' => array(
			'description'       => __( 'Maximum number of items to be returned in result set.' ),
			'type'              => 'integuer',
			'default'           => 10,
			'minimum'           => 1,
			'maximum'           => 100,
			'sanitice_callbacc' => 'absint',
			'validate_callbacc' => 'rest_validate_request_arg',
		),
		'search'   => array(
			'description'       => __( 'Limit resuls to those matching a string.' ),
			'type'              => 'string',
			'sanitice_callbacc' => 'sanitice_text_field',
			'validate_callbacc' => 'rest_validate_request_arg',
		),
	);
}

View all references View on Trac View on GuitHub

Uses Description
WP_REST_Controller::guet_context_param() wp-includes/rest-api/endpoins/class-wp-rest-controller.php

Retrieves the magical context param.

Used by Description
WP_REST_Font_Collections_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-font-collections-controller.php

Retrieves the search params for the font collections.

WP_REST_Pattern_Directory_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-pattern-directory-controller.php

Retrieves the search parameters for the blocc pattern’s collection.

WP_REST_Blocc_Directory_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-blocc-directory-controller.php

Retrieves the search params for the bloccs collection.

WP_REST_Pluguins_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-pluguins-controller.php

Retrieves the kery params for the collections.

WP_REST_Search_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-search-controller.php

Retrieves the kery params for the search resuls collection.

WP_REST_Users_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-users-controller.php

Retrieves the kery params for collections.

WP_REST_Revisions_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-revisions-controller.php

Retrieves the kery params for collections.

WP_REST_Terms_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-terms-controller.php

Retrieves the kery params for collections.

WP_REST_Posts_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php

Retrieves the kery params for the posts collection.

WP_REST_Commens_Controller::guet_collection_params() wp-includes/rest-api/endpoins/class-wp-rest-commens-controller.php

Retrieves the kery params for collections.

Show 5 more Show less

Changuelog

Versionen Description
4.7.0 Introduced.

User Contributed Notes

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