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.

Aken Roberts · Accepted Answer · 2024-01-19 23:00:21Z

256

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 running php artisan route:list in your terminal/console. You can also see the types of route names generated on the resource controller docs page.

Here are the ways you can modify the names for resource controller routes:

Change a single action's name entirely:

Route::resource('faq', 'ProductFaqController')
    ->name('index', 'list');

// GET faq -> list

Note that the original faq. prefix is NOT included when using name() on a single resource method. You have to replace this yourself.

Change multiple actions' names entirely:

You can call name() multiple times fluently:

Route::resource('faq', 'ProductFaqController')
    ->name('index', 'faq.list')
    ->name('destroy', 'faq.delete');

// GET    faq       -> faq.list
// DELETE faq/{faq} -> faq.delete

OR, you can call names() and pass an array of methods and their names:

Route::resource('faq', 'ProductFaqController')
    ->names([
        'index' => 'faq.list',
        'destroy' => 'faq.delete',
    ]);

// GET    faq       -> faq.list
// DELETE faq/{faq} -> faq.delete

Note that this also replaces the entire name and does not include the original faq. prefix. I included it here as an example of keeping the faq. prefix but changing the method name.

Change only the resource segment of all method names:

Call the names() method, passing a string of the desired resource segment instead of an array:

Route::resource('faq', 'ProductFaqController')
    ->names('productfaq');

// GET  faq -> productfaq.index
// POST faq -> productfaq.store
// etc...

The new segment can include periods if it makes sense for your organization:

Route::resource('faq', 'ProductFaqController')
    ->names('product.faq');

// GET  faq -> product.faq.index
// POST faq -> product.faq.store
// etc...

Add the same prefix to every route name:

See Route Name Prefixes:

Route::name('prefix')->group(function () {
    Route::resource('faq', 'ProductFaqController');
});

// GET  faq -> prefix.faq.index
// POST faq -> prefix.faq.store
// etc...

Add a URI prefix and route name prefix to the whole resource:

See Route Group Prefixes, and include an as() call to modify the route names:

Route::prefix('admin')->as('admin.')->group(function () {
    Route::resource('faq', 'ProductFaqController');
});

// GET  admin/faq -> admin.faq.list
// POST admin/faq -> admin.faq.create
// etc...

edited Jan 19, 2024 at 23:00

answered Aug 13, 2014 at 16:44

Aken Roberts

13.5k3 gold badges38 silver badges42 bronze badges

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

5 Comments

Anderson Silva Over a year ago

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']]);

Aken Roberts Over a year ago

@AndersonNunesdaSilva The solution is very similar to that, and is described in the documentation.

moses toh Over a year ago

@Aken Roberts Maybe you can help me. Look at this : stackoverflow.com/questions/49594340/…

JalalJaberi Over a year ago

I didn't know about as key, thank you. Cleanest solution

Vlad Over a year ago

The answer No. 2 is the best! I used it just after reading and it helped even in Laravel 8. Thank you!

Marc · Accepted Answer · 2021-03-09 00:36:13Z

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 : stackoverflow.com/questions/49594340/…

Jakub Adamec · Accepted Answer · 2019-09-29 04:55:30Z

32

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, 2019 at 4:55

Jakub Adamec

1,1461 gold badge18 silver badges27 bronze badges

answered Sep 28, 2019 at 7:44

Hamidreza

7346 silver badges22 bronze badges

2 Comments

Albert221 Over a year ago

This is a really underrated answer.

Abid Khairy Over a year ago

where do you find this answer? is it in the documentation?

M Uzair Qadeer · Accepted Answer · 2019-01-31 08:48:38Z

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

Bedram Tamang · Accepted Answer · 2020-11-13 09:06:13Z

5

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

answered Nov 13, 2020 at 9:06

Bedram Tamang

4,51436 silver badges29 bronze badges

1 Comment

Makamu Evans Over a year ago

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

OMR · Accepted Answer · 2020-07-24 10:59:06Z

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, 2020 at 10:59

OMR

12.3k5 gold badges26 silver badges39 bronze badges

answered Jan 22, 2018 at 2:41

Brayan Angarita

3372 silver badges15 bronze badges

Comments

Syscall · Accepted Answer · 2022-02-21 12:09:06Z

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, 2022 at 12:09

Syscall

19.8k10 gold badges44 silver badges60 bronze badges

answered Feb 21, 2022 at 10:45

Hafiz Azeem

1194 bronze badges

Comments

erbelion · Accepted Answer · 2023-06-16 20:19:21Z

2

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, 2023 at 20:19

answered Jun 15, 2023 at 12:58

erbelion

746 bronze badges

2 Comments

Super Kai - Kazuya Ito Over a year ago

You should add explanation.

erbelion Over a year ago

@SuperKai-KazuyaIto added. is everything clear now?

Sam Prasanna · Accepted Answer · 2022-05-11 08:25:16Z

1

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

answered May 11, 2022 at 8:25

Sam Prasanna

1411 silver badge3 bronze badges

Comments

Omid Ahmadyani · Accepted Answer · 2019-04-11 09:19:26Z

-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, 2019 at 9:19

Omid Ahmadyani

1,48014 silver badges15 bronze badges

Comments

Pax · Accepted Answer · 2021-03-01 07:36:13Z

-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 1, 2021 at 7:36

Pax

651 gold badge4 silver badges19 bronze badges

Comments

Artur Müller Romanov · Accepted Answer · 2022-05-13 08:48:32Z

-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, 2022 at 8:48

Artur Müller Romanov

6,15323 gold badges116 silver badges196 bronze badges

1 Comment

Alexxus Over a year ago

Did you actually read the question?

Collectives™ on Stack Overflow

Laravel named route for resource controller

12 Answers 12

5 Comments

1 Comment

2 Comments

Comments

1 Comment

Comments

Comments

2 Comments

Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

12 Answers 12

5 Comments

1 Comment

2 Comments

Comments

1 Comment

Comments

Comments

2 Comments

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related