HttpException

API reference › yii › web › HttpException

class	yii\web\HttpException
Extends	yii\base\UserException » yii\base\Exception » Exception
Since	2.0
Source	framework/web/HttpException.php

13 subclasses

• BadRequestHttpException
• ConflictHttpException
• ForbiddenHttpException
• GoneHttpException
• MethodNotAllowedHttpException
• NotAcceptableHttpException
• NotFoundHttpException
• RangeNotSatisfiableHttpException
• ServerErrorHttpException
• TooManyRequestsHttpException
• UnauthorizedHttpException
• UnprocessableEntityHttpException
• UnsupportedMediaTypeHttpException

HttpException represents an exception caused by an improper request of the end-user.

HttpException can be differentiated via its $statusCode property value which keeps a standard HTTP status code (e.g. 404, 500). Error handlers may use this status code to decide how to format the error page.

Throwing an HttpException like in the following example will result in the 404 page to be displayed.

if ($item === null) { // item does not exist
    throw new \yii\web\HttpException(404, 'The requested Item could not be found.');
}

Properties

Property	Type	Description	Defined by
$statusCode	int	HTTP status code, such as 403, 404, 500, etc. Default: null.	HttpException

Methods

Method	Description	Defined by
__construct()	Constructor.	HttpException
getName()		HttpException

Method details

__construct()

public function __construct(int $status, string|null $message = null, int $code = 0, Throwable|null $previous = null)

Constructor.

Parameters

Parameter	Type	Description
$status	int	HTTP status code, such as 404, 500, etc.
$message	string|null	Error message
$code	int	Error code
$previous	Throwable|null	The previous exception used for the exception chaining.

getName()

public function getName(): string

Returns

string: The user-friendly name of this exception