Automattic\WooCommerce\Api

ForbiddenException{} │ WC 1.0└─ ApiException

Thrown to signal that the caller is authenticated but lacks permission to perform the requested operation, e.g. the right user but the wrong role, scope, or capability.

Use this for "I know who you are, but you can't do this." For "you need to authenticate first," prefer UnauthorizedException{}.

Wire shape: extensions.code = 'FORBIDDEN', HTTP status 403.

No Hooks.

Usage

$ForbiddenException = new ForbiddenException();
// use class methods

Methods

  1. public __construct(

ForbiddenException{} code WC 10.9.1

woocommerce/src/Api/ForbiddenException.php 
class ForbiddenException extends ApiException {
	/**
	 * Constructor.
	 *
	 * @param string      $message    The error message.
	 * @param array       $extensions Additional error metadata to surface in the GraphQL `extensions` object.
	 * @param ?\Throwable $previous   The previous throwable for chaining.
	 */
	public function __construct(
		string $message = 'Forbidden.',
		array $extensions = array(),
		?\Throwable $previous = null,
	) {
		parent::__construct( $message, 'FORBIDDEN', $extensions, 403, $previous );
	}
}