WP_REST_Request::set_param( string $key, mixed $value )

Sets a parameter on the request.


Description

If the given parameter key exists in any parameter type an update will take place, otherwise a new param will be created in the first parameter type (respecting get_parameter_order()).


Top ↑

Parameters

$key

(string) (Required) Parameter name.

$value

(mixed) (Required) Parameter value.


Top ↑

Source

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

	public function set_param( $key, $value ) {
		$order     = $this->get_parameter_order();
		$found_key = false;

		foreach ( $order as $type ) {
			if ( 'defaults' !== $type && is_array( $this->params[ $type ] ) && array_key_exists( $key, $this->params[ $type ] ) ) {
				$this->params[ $type ][ $key ] = $value;
				$found_key                     = true;
			}
		}

		if ( ! $found_key ) {
			$this->params[ $order[0] ][ $key ] = $value;
		}
	}


Top ↑

Changelog

Changelog
Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes

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