Laravel named route for resource controller

Question

Using Laravel 4.2, is it possible to assign a name to a resource controller route? My route is defined as follows:

Route::resource('faq', 'ProductFaqController');

I tried adding a name option to the route like this:

Route::resource('faq', 'ProductFaqController', array("as"=>"faq"));

However, when I hit the /faq route and place {{ Route::currentRouteName() }} in my view, it yields faq.faq.index instead of just faq.

score 230 · Accepted Answer · edited Nov 27 '15 at 02:27

230

When you use a resource controller route, it automatically generates names for each individual route that it creates. Route::resource() is basically a helper method that then generates individual routes for you, rather than you needing to define each route manually.

You can view the route names generated by typing php artisan routes in Laravel 4 or php artisan route:list in Laravel 5 into your terminal/console. You can also see the types of route names generated on the resource controller docs page (Laravel 4.x | Laravel 5.x).

There are two ways you can modify the route names generated by a resource controller:

Supply a names array as part of the third parameter $options array, with each key being the resource controller method (index, store, edit, etc.), and the value being the name you want to give the route.
```
Route::resource('faq', 'ProductFaqController', [
    'names' => [
        'index' => 'faq',
        'store' => 'faq.new',
        // etc...
    ]
]);
```
Specify the as option to define a prefix for every route name.
```
Route::resource('faq', 'ProductFaqController', [
    'as' => 'prefix'
]);
```
This will give you routes such as prefix.faq.index, prefix.faq.store, etc.

edited Nov 27 '15 at 02:27

Yahya Uddin

26,997
35
140
231

answered Aug 13 '14 at 16:44

Aken Roberts

13,012
3
34
40

Hi I like this solution, but I wanna do it with controller route. Is there any way to do something like this: Route::controller('/', 'HomeController', ['names' => ['home.index' => 'getIndex']]); – Anderson Silva May 20 '15 at 14:26
1

@AndersonNunesdaSilva The solution is very similar to that, and is [described in the documentation](http://laravel.com/docs/5.0/controllers#implicit-controllers). – Aken Roberts May 20 '15 at 16:31
@Aken Roberts Maybe you can help me. Look at this : https://stackoverflow.com/questions/49594340/how-can-i-implement-resource-controllers-if-i-use-many-get-on-the-laravel – moses toh Apr 01 '18 at 03:05
I didn't know about `as` key, thank you. Cleanest solution – JalalJaberi Jun 18 '21 at 11:00

Marc · Answer 2 · 2021-03-09T00:36:13.617

For answer seekers with Laravel 5.5+ finding this page:

Route::namespace('Admin')->prefix('admin')->name('admin.')->group(function () {

    Route::resource('users','UserController');

});

These options will result in the following for the Resource:

namespace() sets Controller namespace to \Admin\UserController
prefix() sets request URi to /admin/users
name() sets route name accessor to route('admin.users.index')

In name() the DOT is intended, it is not a typo.

Please let others know if this works in comments for any versions prior to Laravel 5.5, I will update my answer.

Update:

Taylor accepted my PR to officially document this in 5.5:

https://laravel.com/docs/5.5/routing#route-group-name-prefixes

UPDATE LARAVEL 8

New in Laravel 8, the need to use a namespace in route configs is deprecated, the default namespace wrapper in RouteServiceProvider has been removed from Laravel's standard config. This change decouples Controller namespaces from having to be considered when grouping routes, dropping the namespace requirement when registering routes gives much more freedom when organizing controllers and routes.

With Laravel 8, the original example in the top half of this post would now look as follows using self references to static class name:


use \App\Http\Controllers\Admin\{
    UserController,
    ProductController,
    AnotherController,
}

Route::prefix('admin')->name('admin.')->group(function () {

    Route::resource('users', UserController::class);

    Route::resource('products', ProductController::class);

    Route::resource('another', AnotherController::class);

});

Maybe you can help me. Look at this : https://stackoverflow.com/questions/49594340/how-can-i-implement-resource-controllers-if-i-use-many-get-on-the-laravel — moses toh, Apr 01 '18 at 03:06

score 31 · Answer 3 · edited Sep 29 '19 at 04:55

31

I don't know if it's available in laravel 4.2 (I tested in 5.7) but you can use names to change the name of all routes generated by resource

Route::resource('faq', 'ProductFaqController', ['names' => 'something']);

and the result will be like this

something.index

and you don't need to specify each route

edited Sep 29 '19 at 04:55

Jakub Adamec

953
16
22

answered Sep 28 '19 at 07:44

Hamidreza

694
6
19

3

This is a really underrated answer. – Albert221 May 19 '20 at 20:18
where do you find this answer? is it in the documentation? – Abid Khairy Feb 19 '22 at 09:07

score 8 · Answer 4 · answered Jan 31 '19 at 08:48

All Updates Later then Laravel 5.5 Using

Route::resource('faqs', 'FaqController', ['as' => 'faqs']);

if we not use ['as' => 'faqs'] in above code then it will also work same.

[Updated]

Important to keep in mind that this will work for "resource"

For example:

Route::resource('admin/posts/tags', 'PostTagController', ['as' => 'posts']);

and result will be like

 POST      | admin/posts/tags                  | posts.tags.store
 GET|HEAD  | admin/posts/tags                  | posts.tags.index
 GET|HEAD  | admin/posts/tags/create           | posts.tags.create
 DELETE    | admin/posts/tags/{tag}            | posts.tags.destroy
 PUT|PATCH | admin/posts/tags/{tag}            | posts.tags.update
 GET|HEAD  | admin/posts/tags/{tag}            | posts.tags.show
 GET|HEAD  | admin/posts/tags/{tag}/edit       | posts.tags.edit

score 5 · Answer 5 · answered Nov 13 '20 at 09:06

Tested with Laravel 8:

You can define your name for resource route as passing names as optional arguments. For Example:

use App\Http\Controllers\UsersController;

Route::resource('reservations', UsersController::class, ['names' => 'users']);

The above example defines routes such as users.index, users.store etc.

You can also pass the route names as:

Route::resource('reservations', UsersController::class, ['names' => 'admin.users']);

which will define routes with prefix of admin such as admin.users.index, admin.users.store

on my end this does not generate the correct routes. for example the show route is generated as | GET|HEAD | admin/clients/{} --> empty curly brackets brings issues — Makamu Evans, Jul 30 '21 at 08:59

score 4 · Answer 6 · edited Jul 24 '20 at 10:59

4

Using Laravel 5.5

Route::resource('admin/posts/tags', 'PostTagController', ['as' => 'posts']);

important to keep in mind the "resource"

For example, I send something from my project:

Route::resource('admin/posts/tags', 'PostTagController', ['as' => 'posts']);

edited Jul 24 '20 at 10:59

OMR

11,736
5
20
35

answered Jan 22 '18 at 02:41

Brayan Angarita

307
2
12

score 4 · Answer 7 · edited Feb 21 '22 at 12:09

4

And In Laravel 8

Route::resource('product', 
    App\Http\Controllers\API\Admin\ProductController::class, [
    'names' => [
        'index' => 'admin.product.index', 
        'store' => 'admin.product.store', 
        'update' => 'admin.product.update', 
        'destroy' => 'admin.product.delete'
    ]
])->except(['edit', 'create']);

edited Feb 21 '22 at 12:09

Syscall

19,327
10
37
52

answered Feb 21 '22 at 10:45

Hafiz Azeem

79
3

score 1 · Answer 8 · answered May 11 '22 at 08:25

1

Route::resource('articles','ArticleController', ['names' => 'xyz'])

answered May 11 '22 at 08:25

Sam Prasanna

131
1
3

erbelion · Answer 9 · 2023-06-16T20:19:21.793

0

Route::resource('nice-books', BookController::class)->names('books');

In this line, ->names('books') serves as a books. name prefix to BookController resource routes.

Example effect: route('books.index') -> GET /nice-books

edited Jun 16 '23 at 20:19

answered Jun 15 '23 at 12:58

erbelion

44
6

You should add explanation. – Super Kai - Kazuya Ito Jun 16 '23 at 13:49
@SuperKai-KazuyaIto added. is everything clear now? – erbelion Jun 16 '23 at 20:20

score -1 · Answer 10 · answered Apr 11 '19 at 09:19

-1

you dont need to set name in resource in laravel 5.7 that i have test it. it auto generate route name from url.

answered Apr 11 '19 at 09:19

Omid Ahmadyani

1,430
13
15

score -1 · Answer 11 · answered Mar 01 '21 at 07:36

-1

Got the same error as you. for me it worked by adding the whole path that is namespace/ControllerName

Route::resource('staffs', 'App\Http\Controllers\StaffController');

answered Mar 01 '21 at 07:36

Pax

65
1
4
19

score -2 · Answer 12 · answered May 13 '22 at 08:48

-2

You can rename your resource routes in AppServiceProvider.php like so:

public function boot()
{
    Route::resourceVerbs([
        'create' => 'neu',
        'edit' => 'bearbeiten',
    ]);
}

I believe this feature is designed for localization.

answered May 13 '22 at 08:48

Artur Müller Romanov

4,417
10
73
132

1

Did you actually read the question? – Alexxus Jul 14 '23 at 11:48

Laravel named route for resource controller

12 Answers12

Linked