W3cubDocs

/WordPress

WP_REST_Request::get_header( string $key )

Retrieves the given header from the request.

Description

If the header has multiple values, they will be concatenated with a comma as per the HTTP specification. Be aware that some non-compliant headers (notably cookie headers) cannot be joined this way.

Parameters

$key

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

Return

(string|null) String value if set, null otherwise.

Source

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

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

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

		return implode( ',', $this->headers[ $key ] );
	}

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_header