Customizing route model binding key

Question

I'm calling a route with a variable appended to it's end, like this:

Route::get('/user/{user}', 'UserController@listUser');

That points to a controller with a method like so:

public function listUser(User $user){
   dd($user);
}

That's working just fine; if I go to www.example.com/user/3, Laravel will automatically fetch me the user with id = 3

But I need to change that URL to something like this: www.example.com/users/nickname using a different property of the User model.

If that's possible, how can I do it?

Marcin Nabiałek · Accepted Answer · 2017-02-26 18:35:05Z

8

In this case you need to define in your User Eloquent model the following method:

public function getRouteKeyName()
{
    return 'nickname';
}

You can read more about it in Route Model binding documentation.

answered Feb 26, 2017 at 18:35

Marcin Nabiałek

112k43 gold badges271 silver badges299 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

aphoe · Accepted Answer · 2023-08-11 12:01:14Z

0

In Laravel 10, you could also do the blow

<?php
use App\Models\User;

Route::get('/user/{user:nickname}', function (User $user) {
    return $user;
});

answered Aug 11, 2023 at 12:01

aphoe

2,7762 gold badges32 silver badges34 bronze badges