what is “Named Routes” in Laravel

Posted on by

In Laravel, named routes provide a way to give a specific name to a route, making it easier to generate URLs or redirects to that route throughout your application. By using named routes, you can avoid hardcoding URLs, making your code more maintainable and easier to read. Named routes are especially useful when the URLs might change, as you only need to update the route definition without affecting the rest of your code.

Defining Named Routes

You can define a named route by using the name method when defining the route:

use Illuminate\Support\Facades\Route;

// Named route to a closure
Route::get('/user/profile', function () {
    // ...
})->name('profile');

// Named route to a controller method
Route::get('/user/{id}', [UserController::class, 'show'])->name('user.show');

Generating URLs to Named Routes

You can generate URLs to named routes using the route helper function. This function takes the name of the route and any parameters the route requires:

// Generating a URL to the 'profile' named route
$url = route('profile');

// Generating a URL to the 'user.show' named route with a parameter
$url = route('user.show', ['id' => 1]);

Redirecting to Named Routes

You can redirect to named routes using the redirect helper function with the route method:

use Illuminate\Support\Facades\Redirect;

// Redirecting to the 'profile' named route
return Redirect::route('profile');

// Redirecting to the 'user.show' named route with a parameter
return Redirect::route('user.show', ['id' => 1]);

Example

Here’s a complete example demonstrating the use of named routes:

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\UserController;

// Defining named routes
Route::get('/user/profile', [UserController::class, 'profile'])->name('profile');
Route::get('/user/{id}', [UserController::class, 'show'])->name('user.show');

// Generating URLs to named routes
Route::get('/generate-url', function () {
    $profileUrl = route('profile');
    $userUrl = route('user.show', ['id' => 1]);
    
    return "Profile URL: $profileUrl, User URL: $userUrl";
});

// Redirecting to named routes
Route::get('/redirect-to-profile', function () {
    return redirect()->route('profile');
});

Route::get('/redirect-to-user/{id}', function ($id) {
    return redirect()->route('user.show', ['id' => $id]);
});

Benefits of Using Named Routes

  1. Maintainability: If the URL for a route changes, you only need to update the route definition.
  2. Readability: Named routes make the code more readable and understandable.
  3. Convenience: Generating URLs and redirects becomes simpler and less error-prone.