WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Request::get_header()

WP_REST_Request::get_header( string $key ): string|null

In this article

Back to top

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

$keystringrequired
Header name, will be canonicalized to lowercase.

Return

string|null String value if set, null otherwise.

Source

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

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

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

View all references View on Trac View on GitHub

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

Canonicalizes the header name.

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

Retrieves the Content-Type of the request.

Changelog

VersionDescription
4.4.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Theme.id
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Simple custom wp rest api with check access 

     

 protected $api_key ='some_api_key';

 public function register_routes(){
        $namespace = $this->my_namespace . $this->my_version;
        $base      = 'users';
        register_rest_route( $namespace, '/' . $base, array(
            array(
                'methods'  => WP_REST_Server::EDITABLE,
                'callback' => array( $this, 'users' ),
             'permission_callback' => array( $this, 'check_access' )
            )
        ) );

    }

public function check_access(WP_REST_Request $request){
        $key  = $request->get_header('_key');
        if($key == $this->api_key){
            return true;
        }
        return false;
    }

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