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.


Top ↑

Parameters

$key

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


Top ↑

Return

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


Top ↑

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


Top ↑

Changelog

Changelog
Version Description
4.4.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by Theme.id

    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.