W3cubDocs

/WordPress

WP_REST_Request::get_param( string $key )

Retrieves a parameter from the request.

Parameters

$key

(string) (Required) Parameter name.

Return

(mixed|null) Value if set, null otherwise.

Source

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

public function get_param( $key ) {
		$order = $this->get_parameter_order();

		foreach ( $order as $type ) {
			// Determine if we have the parameter for this type.
			if ( isset( $this->params[ $type ][ $key ] ) ) {
				return $this->params[ $type ][ $key ];
			}
		}

		return null;
	}

Changelog

Version Description
4.4.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_request/get_param