WP_REST_Request::get_header

Advertisement

Summery Summery

Retrieves the given header from the request.

Syntax Syntax

WP_REST_Request::get_header( string $key )

Description 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 Parameters

$key

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

Return Return

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

Source 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 ] );
	}

Advertisement

Changelog Changelog

Changelog
Version Description
4.4.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.