Laravel when() 方法教學

在 Laravel 的 Eloquent 查詢中,通常我們會根據使用者輸入的條件來動態篩選資料,例如:

  • 關鍵字搜尋name
  • 範圍查詢(如 height
  • 特定條件(如 country_id

Laravel 提供了 when() 方法,讓我們可以根據是否有提供值來決定是否加入某個查詢條件,避免不必要的 if 判斷。

1. when() 方法的基本語法

$query->when(條件, function ($q) {
    $q->where(條件);
});

 

  • 條件:如果這個條件為 true,則執行 function 內的 where() 條件。
  • $q(Query Builder):代表當前的查詢物件。

 

 

2. when() 基本範例

傳統 if 判斷

$query = User::query();

if ($request->filled('keyword')) {
    $query->where('name', 'like', "%{$request->keyword}%");
}

$users = $query->get();

這種寫法雖然可以用,但如果有很多條件,if 會讓程式碼變得冗長。

使用 when() 優化

$query = User::query();

$query->when($request->input('keyword'), function ($q, $keyword) {
    $q->where('name', 'like', "%{$keyword}%");
});

$users = $query->get();
  • keyword 存在時,才會執行 where('name', 'like', "%{$keyword}%")
  • keyword 沒有輸入時,這條查詢條件就不會被加進去。

這樣可以減少 if 判斷,使程式碼更簡潔。

 

3. 多個搜尋條件的 when() 應用

當有多個條件時,when() 可以幫助我們避免過多的 if 判斷。

搜尋「關鍵字 + 身高範圍 + 國籍」

$query = User::query();

// 關鍵字搜尋(姓名)
$query->when($request->input('keyword'), function ($q, $keyword) {
    $q->where('name', 'like', "%{$keyword}%");
});

// 身高範圍(最小身高)
$query->when($request->input('min_height'), function ($q, $min) {
    $q->where('height', '>=', $min);
});

// 身高範圍(最大身高)
$query->when($request->input('max_height'), function ($q, $max) {
    $q->where('height', '<=', $max);
});

// 根據國籍搜尋
$query->when($request->input('country_id'), function ($q, $countryId) {
    $q->where('country_id', $countryId);
});

$users = $query->get();

這樣,只有當對應的參數存在時,才會執行相應的 where() 條件,讓查詢更靈活! 

 

4. when() 搭配 whereIn() 

如果 country_id 需要支援多選(多個國籍),可以使用 whereIn()

$query->when($request->input('country_ids'), function ($q, $countryIds) {
    $q->whereIn('country_id', $countryIds);
});

 

5. when() 搭配 orWhere()

如果需要搜尋關鍵字可以匹配多個欄位(例如 nameemail),可以這樣寫:

$query->when($request->input('keyword'), function ($q, $keyword) {
    $q->where('name', 'like', "%{$keyword}%")
      ->orWhere('email', 'like', "%{$keyword}%");
});

這樣,keyword 存在時,會搜尋 nameemail 兩個欄位。 

 

6. when() 的第三個參數 

when() 也可以接受 第三個參數,這是一個 else 條件,當條件為 false 時執行:

$query->when($request->input('active'), function ($q) {
    $q->where('status', 'active');
}, function ($q) {
    $q->where('status', 'inactive');
});

這樣:

  • active 存在時,搜尋 status = active
  • active 不存在時,搜尋 status = inactive

 

總結

when() 方法是 Laravel 查詢時的強大工具,可以根據是否提供參數來決定是否加入條件。
透過 when(),可以讓查詢語法變得簡潔、可讀性更高。
可搭配 whereIn()orWhere() 來實現更複雜的查詢邏輯。

如果你的查詢條件很多,推薦使用 when(),避免多個 if 判斷,讓程式碼更乾淨、更高效!

課程推薦

用 AI 生成網站? AI 高效網站設計實戰課:ChatGPT X HTML X SEO

用 AI 生成網站? AI 高效網站設計實戰課:ChatGPT X HTML X SEO

利用 AI 提升網站設計效率與 SEO 排名!了解如何透過 ChatGPT 等工具快速建立 HTML 架構,優化關鍵字與用戶體驗,讓網站更具競爭力。

輸入折扣碼 TC1533SL 還可以額外獲得 NT$500 優惠喔。

AI工作術全面學習實戰營:6 堂精選課程,學會最好用 AI 工具,翻轉你的人生

AI工作術全面學習實戰營:6 堂精選課程,學會最好用 AI 工具,翻轉你的人生

《PChome雜誌》攜手 5 位在 AI 領域的專業講師,打造上述 6 堂實用課程,教你學會時下最好用的 AI 工具,導入生成式 AI 來產製工作內容,改造並升級你的工作流程。

輸入折扣碼 ZERO2024 還可以額外獲得 NT$400 優惠喔。

HTML與SEO實戰應用—並以ChatGPT助力提升網站品質與流量

HTML與SEO實戰應用—並以ChatGPT助力提升網站品質與流量

本課程專為希望深入了解 HTML 並有效結合 SEO 策略的學員設計。我們將重點放在 HTML 的深度學習與應用上,同時穿插介紹如何透過搜索引擎優化提升網站能見度。透過即時互動式的直播教學,加上 ChatGPT 的輔助,您將學習到如何建立一個結構優良、美觀且符合 SEO 標準的網站。這不僅會提升網站的用戶體驗,還會大幅提高網站的搜索引擎排名,進而增加訪客流量和潛在客戶。
用AI強化職場競爭力 ChatGPT、Midjourney從入門到精通

用AI強化職場競爭力 ChatGPT、Midjourney從入門到精通

在快速變遷的職場中,提升競爭力成為關鍵。透過引領潮流的AI技術,ChatGPT和Midjourney將助您勇攀高峰。無論您是AI新手還是專家,這個課程將引導您從入門到精通,解密AI的奧秘,並學習如何運用於職場。
GitHub Copilot AI 程式碼編輯工具應用實務班

GitHub Copilot AI 程式碼編輯工具應用實務班

讓學員瞭解有效地使用該工具來加速開發流程、提高程式碼品質和生產力。課程重點放在以 JavaScript 程式語言為例,介紹 Copilot 的基本原理、使用方法和最佳實踐。

輸入折扣碼 TC1456JA 還可以額外獲得 NT$500 優惠喔。

ChatGPT X Clipchamp AI 生成影片、配音與字幕應用實戰班

ChatGPT X Clipchamp AI 生成影片、配音與字幕應用實戰班

掌握Clipchamp AI的操作技巧,靈活運用Clipchamp AI進行影片編輯和創作,實現創意表達和傳播目的。

輸入折扣碼 TC1451JAN 還可以額外獲得 NT$500 優惠喔。

如何串接多種數位工具資訊?Looker Studio 資料視覺化實戰班|GoogleAds x FB廣告 x GA流量數據

如何串接多種數位工具資訊?Looker Studio 資料視覺化實戰班|GoogleAds x FB廣告 x GA流量數據

Looker Studio除了可協助使用者監控網站流量、廣告成效、選擇匯入資源的管道之外,還可以將數據資料多平台整合、數據報表即時更新、數據範本可重複套用的效益,透過自動化系統,將數據全部匯入同一個報表平台,是企業不可或缺的重要工具。

輸入折扣碼 TC1270JIA 還可以額外獲得 NT$500 優惠喔。

和我們交流

加入我們的社群,裡面會有一些技術的內容、有趣的技術梗,以及職缺的分享,歡迎和我們一起討論。