WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Request::get_param()

WP_REST_Request::get_param( string $key ): mixed|null

In this article

Back to top

Retrieves a parameter from the request.

Parameters

$keystringrequired
Parameter name.

Return

mixed|null Value if set, null otherwise.

Source

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;
}

View all references View on Trac View on GitHub

UsesDescription
WP_REST_Request::get_parameter_order()wp-includes/rest-api/class-wp-rest-request.php

Retrieves the parameter priority order.

Used byDescription
WP_REST_Request::has_valid_params()wp-includes/rest-api/class-wp-rest-request.php

Checks whether this request is valid according to its attributes.

WP_REST_Request::offsetGet()wp-includes/rest-api/class-wp-rest-request.php

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

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