Class WC_REST_Authentication

REST API authentication class.

Package: WooCommerce\API
Located at api/class-wc-rest-authentication.php

Methods summary

`public`	# `__construct( )` Initialize authentication actions. Initialize authentication actions.
`protected boolean`	# `is_request_to_rest_api( )` Check if is request to our REST API. Check if is request to our REST API. Returns boolean
`public integer\|false`	# `authenticate( integer\|false $user_id )` Authenticate user. Authenticate user. Parameters `$user_id` User ID if one has been determined, false otherwise. Returns integer\|false
`public WP_Error\|null\|boolean`	# `check_authentication_error( WP_Error\|null\|boolean $error )` Check for authentication error. Check for authentication error. Parameters `$error` Error data. Returns WP_Error\|null\|boolean
`protected`	# `set_error( WP_Error $error )` Set authentication error. Set authentication error. Parameters `$error` Authentication error data.
`protected WP_Error\|null.`	# `get_error( )` Get authentication error. Get authentication error. Returns WP_Error\|null.
`public array`	# `parse_header( string $header )` Parse the Authorization header into parameters. Parse the Authorization header into parameters. Parameters `$header` Authorization header value (not including "Authorization: " prefix). Returns array Map of parameter values. Since 3.0.0
`public string`	# `get_authorization_header( )` Get the authorization header. Get the authorization header. On certain systems and configurations, the Authorization header will be stripped out by the server or PHP. Typically this is then used to generate `PHP_AUTH_USER`/`PHP_AUTH_PASS` but not passed on. We use `getallheaders` here to try and grab it out instead. Returns string Authorization header if set. Since 3.0.0
`public array\|WP_Error`	# `get_oauth_parameters( )` Get oAuth parameters from $_GET, $_POST or request header. Get oAuth parameters from $_GET, $_POST or request header. Returns array\|WP_Error Since 3.0.0
`public WP_REST_Response`	# `send_unauthorized_headers( WP_REST_Response $response )` If the consumer_key and consumer_secret $_GET parameters are NOT provided and the Basic auth headers are either not present or the consumer secret does not match the consumer key provided, then return the correct Basic headers and an error message. If the consumer_key and consumer_secret $_GET parameters are NOT provided and the Basic auth headers are either not present or the consumer secret does not match the consumer key provided, then return the correct Basic headers and an error message. Parameters `$response` Current response being served. Returns WP_REST_Response
`public mixed`	# `check_user_permissions( mixed $result, WP_REST_Server $server, WP_REST_Request $request )` Check for user permissions and register last access. Check for user permissions and register last access. Parameters `$result` Response to replace the requested version with. `$server` Server instance. `$request` Request used to generate the response. Returns mixed

Properties summary

`protected WP_Error`	`$error` Authentication error. Authentication error.	# `null`
`protected stdClass`	`$user` Logged in user data. Logged in user data.	# `null`
`protected string`	`$auth_method` Current auth method. Current auth method.	# `''`