Laravel 5: Custom abort() message

Question

Using Laravel 5, I want to send a custom abort() message.
For example, if the user doesn't have the required permissions for an action,
I'd like to abort(401, "User can't perform this actions").
Currently, when I do so, the response text is HTML page and not the message.
How can I return only the message?

Note: I don't want to pass a different view, but only the custom message.

Possible duplicate of [Pass a custom message (or any other data) to Laravel 404.blade.php](http://stackoverflow.com/questions/29163564/pass-a-custom-message-or-any-other-data-to-laravel-404-blade-php) — Tim, Jul 26 '16 at 09:39
This behavior was fixed in Laravel 5.5. It will give back a JSON-formatted error that includes your message automatically when you call `abort($code, $message)` (provided `$request->wantsJson()`). — amphetamachine, Jul 14 '22 at 19:22

score 37 · Answer 1 · answered Aug 05 '17 at 06:51

37

According to Laravel 5.4 documentation:

https://laravel.com/docs/5.4/errors#http-exceptions

You can use abort helper with response text:

abort(500, 'Something went wrong');

And use $exception->getMessage() in resources/views/errors/500.blade.php to display it:

Error message: {{ $exception->getMessage() }}

answered Aug 05 '17 at 06:51

Kenny

579
5
8

This would be the correct way to do this, but how would I add 'newline' character, or line break (or bullets even better) in this message? – blamb Dec 11 '17 at 22:11
2

@blamb If the message contains HTML code (like
), use {!! !!} syntax instead of {{ }} to display unescaped content. – Kenny Dec 13 '17 at 11:40
2

in laravel 5.7 `@section('message', __( $exception->getMessage() ? $exception->getMessage() :'Whoops, something went wrong on our servers.'))` – ManojKiran A Jan 28 '19 at 09:46

score 19 · Answer 2 · edited Aug 12 '19 at 15:52

19

You can wrap a response inside abort, which will stop the execution and return the response. If you want it to be JSON then add ->json();

# Regular response
abort( response('Unauthorized', 401) );

# JSON response 
abort( response()->json('Unauthorized', 401) );

edited Aug 12 '19 at 15:52

wolmi

1,659
12
25

answered Aug 12 '19 at 15:21

xcitic

191
1
6

Shorter if we use an array message `abort( response(['message' => 'Unauthorized'], 401) );` for JSON. – Christos Lytras Nov 03 '21 at 17:50

score 12 · Answer 3 · answered Jul 27 '16 at 11:30

12

The answer is simply to use the response() helper method instead of abort(). Syntax as below.

return response("User can't perform this action.", 401);

answered Jul 27 '16 at 11:30

ShaunUK

929
6
17

4

However, `return` would continue with the execution of the caller. With `abort`, I don't want carry on with any business logic. – Jānis Elmeris Oct 31 '17 at 18:09
Oh, and this doesn't work either, at least in my app it didn't. `response('', 400)->json('some message')` still returned HTML page. – Jānis Elmeris Oct 31 '17 at 18:18

vijaykumar · Answer 4 · 2016-07-26T09:38:23.060

1

You can handle all error exceptions here app/Exceptions/Handler.php Class On your requirement.

In your case just replace render function with this

public function render($request, Exception $e)
{
   return $e->getMessage();
   //For Json
   //return response()->json(['message' => $e->getMessage()]);
}

edited Jul 26 '16 at 09:38

answered Jul 26 '16 at 09:22

vijaykumar

4,658
6
37
54

1

I tried it, but then it won't get to the .catch in the browser. – Sharon Haim Pour Jul 26 '16 at 09:27
i didn't get you "it won't get to the .catch in the browser" means – vijaykumar Jul 26 '16 at 09:30
Using Promise: promise.then(this._thenMethod).catch(this._defaultCatcher); – Sharon Haim Pour Jul 26 '16 at 09:32
Okay. I'm not sure but try send response as json like this return response()->json(['message' => $e->getMessage()]); – vijaykumar Jul 26 '16 at 09:37

score 1 · Answer 5 · edited Jan 19 '18 at 09:22

1

Should be able to use the following in the template:

{{ $exception->getMessage() }}

edited Jan 19 '18 at 09:22

Yidir

583
7
12

answered Jan 17 '17 at 12:32

knorthfield

718
7
15

Sharon Haim Pour · Answer 6 · 2016-07-26T11:59:18.320

0

In Handler.php I altered the function:

 public function render($request, Exception $e)
{
    $response = parent::render($request, $e);

    if (method_exists($e, "getStatusCode")) {
        if ($e->getStatusCode() == 401) {
            $response->setContent($e->getMessage());
        }
    }

    return $response;
}

edited Jul 26 '16 at 11:59

answered Jul 26 '16 at 11:29

Sharon Haim Pour

6,595
12
42
64

score 0 · Answer 7 · answered May 16 '22 at 22:23

0

I find this to be very clean if you are writing API's instead of using the default abort() exception error ):

 abort( response()->json(["message"=>"an error occur"], Response::HTTP_NOT_FOUND) );

answered May 16 '22 at 22:23

Slycreator

1,144
11
18

not working with laravel 9 – Alauddin Afif Cassandra Oct 12 '22 at 04:17
I am currently using it in Laravel 9 and it works. can you share what error you are getting when you tried it . – Slycreator Oct 14 '22 at 19:20
use Illuminate\Support\Facades\Response; – Jason Jan 02 '23 at 20:00

score 0 · Answer 8 · edited May 18 '23 at 16:17

0

In api.php file, add this

 Route::fallback(function () {
  return abort(401,"User can't perform this action.");
 });

edited May 18 '23 at 16:17

helvete

2,455
13
33
37

answered May 16 '23 at 10:50

Sreejith N

25
5

score -1 · Answer 9 · answered Jul 26 '16 at 09:36

First of all add the error message in your header file or in the page where you want to show the message like:

@if($errors->has())
    @foreach ($errors->all() as $error)
        <div>{{ $error }}</div>
    @endforeach
@endif

And in the controller, you can do this kind of stuff (e.g.):

public function store(){
    if(user is not permitted to access this action) // check user permission here
    {
        return redirect()->back()->withErrors("User can't perform this actions");
    }
}

You can redirect back with error message

I should add that I'm talking about an $.ajax call and not browser redirect. — Sharon Haim Pour, Jul 26 '16 at 09:38

Laravel 5: Custom abort() message

9 Answers9

Linked