WP_REST_Request::get_header_as_array() WordPress Method

The WP_REST_Request::get_header_as_array() function is used to get the value of a header from a WordPress REST API request. This function takes the header name as a string and returns an array of values for that header.

WP_REST_Request::get_header_as_array( string $key ) #

Retrieves header values from the request.


Parameters

$key

(string)(Required)Header name, will be canonicalized to lowercase.


Top ↑

Return

(array|null) List of string values if set, null otherwise.


Top ↑

Source

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

	public function get_header_as_array( $key ) {
		$key = $this->canonicalize_header_name( $key );

		if ( ! isset( $this->headers[ $key ] ) ) {
			return null;
		}

		return $this->headers[ $key ];
	}


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.