[Laravel] URLパラメーターを取得・出力する
Tech※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。
一覧の検索条件を引き継ぎたいときなど、「今のURLのパラメーター」が欲しくなる場面は意外と多いので、取り方をまとめておきます。
クエリ文字列を丸ごと取る
/items?category=guitar&page=2 の category=guitar&page=2 部分を取ります。
$request->getQueryString();
Blade で呼ぶ場合はヘルパー経由で。
request()->getQueryString()
ℹ️
getQueryString()は Symfony の Request 由来のメソッドで、パラメーターをキー名順に並べ替えて正規化した文字列を返します。URLに書かれた順番そのままではないので、順序に意味を持たせている場合は注意。
値を1つずつ取る
実際には、丸ごとより個別に取る場面の方が多いです。
$request->query('page'); // クエリ文字列だけから取る
$request->query('page', 1); // 無ければデフォルト値
$request->input('category'); // クエリ + POSTボディから取る
$request->query(); // クエリを連想配列で全部
| メソッド | どこから取るか |
|---|---|
query() | URLのクエリ文字列だけ |
input() | クエリ文字列 + リクエストボディ(フォーム・JSON) |
all() | 上記すべてを配列で |
GETの検索フォームなら query()、POSTも含めて受けるなら input()、と使い分けると読み手に意図が伝わります。
Blade で値を出力する
{{ request('category') }}
{{ request()->query('page', 1) }}
request('キー') は input() と同じ動きをするショートカットです。
⚠️ URLのパラメーターはユーザーがいくらでも書き換えられる値です。Blade では必ず
{{ }}(エスケープあり)で出力し、{!! !!}は使わないこと。
URLごと取る
| やりたいこと | コード |
|---|---|
| クエリなしのURL | $request->url() |
| クエリ込みのURL | $request->fullUrl() |
| クエリを差し替えたURL | $request->fullUrlWithQuery(['page' => 3]) |
「検索条件はそのまま、ページだけ変える」なら fullUrlWithQuery が便利です。
ルートパラメーターとの違い
/items/{id} の {id} 部分はクエリではなくルートパラメーターなので、取り方が違います。
Route::get('/items/{id}', function (string $id) {
// $id に入ってくる
});
// コントローラー内で Request から取るなら
$request->route('id');
query('id') で取ろうとして null になる、というのは一度はやるミス。
ページネーションに検索条件を引き継ぐ
検索条件を残したままページ送りしたいなら、これ。
$items = Item::where('category', $request->query('category'))
->paginate(20)
->withQueryString();
withQueryString() を付けると、ページネーションのリンクに今のクエリ文字列が自動で付きます。
まとめ
- クエリ文字列を丸ごと:
getQueryString()(キー順に正規化される) - 値を個別に:
query()(クエリのみ)/input()(ボディ込み) - Blade では
request('キー')、出力は必ず{{ }} /items/{id}はルートパラメーターなのでroute('id')
Laravel