基本 - URL 生成（URL Generation） - 《Laravel 11.x ドキュメント》日本語

はじめに
基本
- URLの生成
- 現在のURLへのアクセス
名前付きルートのURL
- Eloquentモデル
署名付きURL
- 署名付きルートリクエストの検証
- 無効な署名付きルートへの応答
コントローラーアクションのURL
デフォルト値

はじめに

Laravelは、アプリケーションのURLを生成するためのいくつかのヘルパーを提供します。これらのヘルパーは、主にテンプレートやAPIレスポンスでリンクを構築する際、またはアプリケーションの別の部分へのリダイレクトレスポンスを生成する際に役立ちます。

基本

URLの生成


``````php
$post = App\Models\Post::find(1);
echo url("/posts/{$post->id}");
// http://example.com/posts/1
`

クエリ文字列パラメータを持つURLを生成するには、queryメソッドを使用できます:

echo url()->query('/posts', ['search' => 'Laravel']);
// https://example.com/posts?search=Laravel
echo url()->query('/posts?sort=latest', ['search' => 'Laravel']);
// http://example.com/posts?sort=latest&search=Laravel

パスに既に存在するクエリ文字列パラメータを提供すると、その既存の値が上書きされます:

echo url()->query('/posts?sort=latest', ['sort' => 'oldest']);
// http://example.com/posts?sort=oldest

値の配列もクエリパラメータとして渡すことができます。これらの値は、生成されたURLで適切にキー付けされ、エンコードされます:

echo $url = url()->query('/posts', ['columns' => ['title', 'body']]);
// http://example.com/posts?columns%5B0%5D=title&columns%5B1%5D=body
echo urldecode($url);
// http://example.com/posts?columns[0]=title&columns[1]=body

現在のURLへのアクセス


``````php
// Get the current URL without the query string...
echo url()->current();
// Get the current URL including the query string...
echo url()->full();
// Get the full URL for the previous request...
echo url()->previous();
`

これらのメソッドのそれぞれは、URL ファサードを介してもアクセスできます:

use Illuminate\Support\Facades\URL;
echo URL::current();

名前付きルートのURL


``````php
Route::get('/post/{post}', function (Post $post) {
   // ...
})->name('post.show');
`

このルートへのURLを生成するには、routeヘルパーを次のように使用できます:

echo route('post.show', ['post' => 1]);
// http://example.com/post/1

もちろん、routeヘルパーを使用して、複数のパラメータを持つルートのURLを生成することもできます:

Route::get('/post/{post}/comment/{comment}', function (Post $post, Comment $comment) {
   // ...
})->name('comment.show');
echo route('comment.show', ['post' => 1, 'comment' => 3]);
// http://example.com/post/1/comment/3

ルートの定義パラメータに対応しない追加の配列要素は、URLのクエリ文字列に追加されます:

echo route('post.show', ['post' => 1, 'search' => 'rocket']);
// http://example.com/post/1?search=rocket

Eloquentモデル

あなたはしばしば、Eloquentモデルのルートキー（通常は主キー）を使用してURLを生成します。このため、Eloquentモデルをパラメータ値として渡すことができます。routeヘルパーは、自動的にモデルのルートキーを抽出します:

echo route('post.show', ['post' => $post]);

署名付きURL

Laravelは、名前付きルートへの「署名付き」URLを簡単に作成できるようにします。これらのURLには、クエリ文字列に「署名」ハッシュが追加されており、LaravelがURLが作成されて以来変更されていないことを確認できます。署名付きURLは、公開アクセス可能でありながらURL操作に対する保護層が必要なルートに特に便利です。

たとえば、署名付きURLを使用して、顧客にメールで送信される公開の「購読解除」リンクを実装することができます。名前付きルートへの署名付きURLを作成するには、signedRouteメソッドをURLファサードで使用します:

use Illuminate\Support\Facades\URL;
return URL::signedRoute('unsubscribe', ['user' => 1]);

署名付きURLハッシュからドメインを除外するには、absolute引数をsignedRouteメソッドに提供します:

return URL::signedRoute('unsubscribe', ['user' => 1], absolute: false);

指定された時間が経過した後に期限切れになる一時的な署名付きルートURLを生成したい場合は、temporarySignedRouteメソッドを使用できます。Laravelが一時的な署名付きルートURLを検証するとき、署名付きURLにエンコードされた有効期限のタイムスタンプが経過していないことを確認します:

use Illuminate\Support\Facades\URL;
return URL::temporarySignedRoute(
   'unsubscribe', now()->addMinutes(30), ['user' => 1]
);

署名付きルートリクエストの検証

受信リクエストに有効な署名があることを確認するには、受信したIlluminate\Http\RequestインスタンスでhasValidSignatureメソッドを呼び出す必要があります:

use Illuminate\Http\Request;
Route::get('/unsubscribe/{user}', function (Request $request) {
   if (! $request->hasValidSignature()) {
   abort(401);
   }
   // ...
})->name('unsubscribe');

場合によっては、クライアント側のページネーションを行う際に、アプリケーションのフロントエンドが署名付きURLにデータを追加できるようにする必要があります。したがって、署名付きURLを検証する際に無視すべきリクエストクエリパラメータを指定できます。パラメータを無視することは、誰でもリクエストのそのパラメータを変更できることを意味します:

if (! $request->hasValidSignatureWhileIgnoring(['page', 'order'])) {
   abort(401);
}

受信リクエストインスタンスを使用して署名付きURLを検証する代わりに、signed（Illuminate\Routing\Middleware\ValidateSignature）ミドルウェアをルートに割り当てることができます。受信リクエストに有効な署名がない場合、ミドルウェアは自動的に403 HTTPレスポンスを返します:

Route::post('/unsubscribe/{user}', function (Request $request) {
   // ...
})->name('unsubscribe')->middleware('signed');

署名付きURLにドメインが含まれていない場合は、ミドルウェアにrelative引数を提供する必要があります:

Route::post('/unsubscribe/{user}', function (Request $request) {
   // ...
})->name('unsubscribe')->middleware('signed:relative');

無効な署名付きルートへの応答

誰かが期限切れの署名付きURLを訪れると、403 HTTPステータスコードの一般的なエラーページが表示されます。ただし、アプリケーションのbootstrap/app.phpファイルでInvalidSignatureException例外のカスタム「レンダリング」クロージャを定義することで、この動作をカスタマイズできます:

use Illuminate\Routing\Exceptions\InvalidSignatureException;
->withExceptions(function (Exceptions $exceptions) {
   $exceptions->render(function (InvalidSignatureException $e) {
   return response()->view('errors.link-expired', status: 403);
   });
})

コントローラーアクションのURL


``````php
use App\Http\Controllers\HomeController;
$url = action([HomeController::class, 'index']);
`

コントローラーメソッドがルートパラメータを受け入れる場合、関数の第2引数としてルートパラメータの連想配列を渡すことができます:

$url = action([UserController::class, 'profile'], ['id' => 1]);

デフォルト値

一部のアプリケーションでは、特定のURLパラメータに対してリクエスト全体のデフォルト値を指定したい場合があります。たとえば、多くのルートが{locale}パラメータを定義しているとします:

Route::get('/{locale}/posts', function () {
   // ...
})->name('post.index');


``````php
<?php
namespace App\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\URL;
use Symfony\Component\HttpFoundation\Response;
class SetDefaultLocaleForUrls
{
   /**
     * Handle an incoming request.
   *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
   */
   public function handle(Request $request, Closure $next): Response
   {
   URL::defaults(['locale' => $request->user()->locale]);
   return $next($request);
   }
}
`

 <a name="url-defaults-middleware-priority"></a>
#### URLのデフォルトとミドルウェアの優先順位
URLのデフォルト値を設定すると、Laravelの暗黙のモデルバインディングの処理に干渉する可能性があります。したがって、URLデフォルトを設定するミドルウェアの[優先順位を付ける](e83dea69e84000f7.md#sorting-middleware)必要があります。これにより、Laravel自身の`````SubstituteBindings`````ミドルウェアの前に実行されるようにできます。これを実現するには、アプリケーションの`````bootstrap/app.php`````ファイル内の`````priority`````ミドルウェアメソッドを使用します:  
``````php
->withMiddleware(function (Middleware $middleware) {
   $middleware->priority([
   \Illuminate\Foundation\Http\Middleware\HandlePrecognitiveRequests::class,
   \Illuminate\Cookie\Middleware\EncryptCookies::class,
   \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
   \Illuminate\Session\Middleware\StartSession::class,
   \Illuminate\View\Middleware\ShareErrorsFromSession::class,
   \Illuminate\Foundation\Http\Middleware\ValidateCsrfToken::class,
   \Illuminate\Contracts\Auth\Middleware\AuthenticatesRequests::class,
   \Illuminate\Routing\Middleware\ThrottleRequests::class,
   \Illuminate\Routing\Middleware\ThrottleRequestsWithRedis::class,
   \Illuminate\Session\Middleware\AuthenticateSession::class,
   \App\Http\Middleware\SetDefaultLocaleForUrls::class,
   \Illuminate\Routing\Middleware\SubstituteBindings::class,
   \Illuminate\Auth\Middleware\Authorize::class,
   ]);
})
`