WP_REST_Request::get_params() WordPress Method

The WP_REST_Request::get_params() method is used to retrieve all parameters from a request. This is useful for getting data from user input, such as from a form.

WP_REST_Request::get_params() #

Retrieves merged parameters from the request.


Description

The equivalent of get_param(), but returns all parameters for the request. Handles merging all the available values into a single array.


Top ↑

Return

(array) Map of key to value.


Top ↑

Source

File: wp-includes/rest-api/class-wp-rest-request.php

	public function get_params() {
		$order = $this->get_parameter_order();
		$order = array_reverse( $order, true );

		$params = array();
		foreach ( $order as $type ) {
			// array_merge() / the "+" operator will mess up
			// numeric keys, so instead do a manual foreach.
			foreach ( (array) $this->params[ $type ] as $key => $value ) {
				$params[ $key ] = $value;
			}
		}

		return $params;
	}


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.