表單驗證

簡介
驗證快速入門
Form Request 驗證
手動建立驗證器
使用驗證過的輸入資料
使用錯誤訊息
可用的驗證規則
依條件增加規則
驗證陣列
- 驗證巢狀陣列輸入資料
- 錯誤訊息的索引與位置
驗證檔案
驗證密碼
自訂驗證規則

簡介

Laravel 提供了幾種不同的方法來驗證應用程式傳入的資料。最常見的做法是使用所有傳入 HTTP 請求中都可使用的 validate 方法。不過，我們也會討論其他的驗證方式。

Laravel 包含了各種方便的驗證規則，您可以將其套用至資料上，甚至還提供了驗證值在指定資料庫資料表中是否為唯一的功能。我們將詳細介紹這些驗證規則中的每一項，以便您熟悉 Laravel 的所有驗證功能。

驗證快速入門

為了瞭解 Laravel 強大的驗證功能，讓我們來看一個完整的範例，包含如何驗證表單以及如何將錯誤訊息顯示給使用者。透過閱讀這篇概覽，您將能對如何使用 Laravel 驗證傳入的請求資料有一個良好的通盤瞭解：

定義路由

首先，假設我們在 routes/web.php 檔案中定義了以下路由：

php

use App\Http\Controllers\PostController;

Route::get('/post/create', [PostController::class, 'create']);
Route::post('/post', [PostController::class, 'store']);

GET 路由將顯示一個表單供使用者建立新的部落格文章，而 POST 路由則會將新的部落格文章儲存到資料庫中。

建立控制器

接著，讓我們看看一個處理這些路由請求的簡單控制器。我們暫時先讓 store 方法保持空白：

php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\View\View;

class PostController extends Controller
{
    /**
     * Show the form to create a new blog post.
     */
    public function create(): View
    {
        return view('post.create');
    }

    /**
     * Store a new blog post.
     */
    public function store(Request $request): RedirectResponse
    {
        // Validate and store the blog post...

        $post = /** ... */

        return to_route('post.show', ['post' => $post->id]);
    }
}

撰寫驗證邏輯

現在我們準備在 store 方法中填入驗證新部落格文章的邏輯。為此，我們將使用 Illuminate\Http\Request 物件提供的 validate 方法。如果驗證規則通過，您的程式碼將繼續正常執行；但如果驗證失敗，則會拋出 Illuminate\Validation\ValidationException 異常，並自動將適當的錯誤回應傳回給使用者。

如果在傳統的 HTTP 請求期間驗證失敗，則會產生一個指向前一個 URL 的重新導向回應。如果傳入的請求是 XHR 請求，則會傳回包含驗證錯誤訊息的 JSON 回應。

為了更深入瞭解 validate 方法，讓我們回到 store 方法：

php

/**
 * Store a new blog post.
 */
public function store(Request $request): RedirectResponse
{
    $validated = $request->validate([
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ]);

    // The blog post is valid...

    return redirect('/posts');
}

如您所見，驗證規則被傳入 validate 方法中。別擔心——所有可用的驗證規則都有詳細文件說明。同樣地，如果驗證失敗，會自動產生適當的回應。如果驗證通過，我們的控制器將繼續執行正常程序。

或者，驗證規則可以指定為規則陣列，而不是單個以 | 分隔的字串：

php

$validatedData = $request->validate([
    'title' => ['required', 'unique:posts', 'max:255'],
    'body' => ['required'],
]);

此外，您可以使用 validateWithBag 方法來驗證請求，並將任何錯誤訊息儲存在命名的錯誤包 (Error Bags) 中：

php

$validatedData = $request->validateWithBag('post', [
    'title' => ['required', 'unique:posts', 'max:255'],
    'body' => ['required'],
]);

在首次驗證失敗時停止

有時您可能希望在某個屬性首次驗證失敗後就停止執行後續的驗證規則。為此，請將 bail 規則分配給該屬性：

php

$request->validate([
    'title' => 'bail|required|unique:posts|max:255',
    'body' => 'required',
]);

在這個範例中，如果 title 屬性的 unique 規則失敗，則不會檢查 max 規則。規則將按照分配的順序進行驗證。

關於巢狀屬性的注意事項

如果傳入的 HTTP 請求包含「巢狀」欄位資料，您可以在驗證規則中使用「點 (dot)」語法來指定這些欄位：

php

$request->validate([
    'title' => 'required|unique:posts|max:255',
    'author.name' => 'required',
    'author.description' => 'required',
]);

另一方面，如果您的欄位名稱包含實體的句點，您可以透過反斜線轉義句點，來明確防止其被解釋為「點」語法：

php

$request->validate([
    'title' => 'required|unique:posts|max:255',
    'v1\.0' => 'required',
]);

顯示驗證錯誤

那麼，如果傳入的請求欄位未通過指定的驗證規則會發生什麼事呢？如前所述，Laravel 將自動將使用者重新導向回其先前的位置。此外，所有的驗證錯誤與請求輸入資料都將自動被快閃 (Flash) 到 Session 中。

$errors 變數會透過由 web 中介層群組提供的 Illuminate\View\Middleware\ShareErrorsFromSession 中介層與應用程式的所有 View 共享。當套用此中介層時，$errors 變數在您的 View 中將始終可用，讓您可以方便地假設 $errors 變數始終已被定義且可以安全地使用。$errors 變數將是 Illuminate\Support\MessageBag 的實例。有關使用此物件的更多資訊，請參閱其文件。

因此，在我們的範例中，當驗證失敗時，使用者將被重新導向到控制器的 create 方法，讓我們能在 View 中顯示錯誤訊息：

blade

<!-- /resources/views/post/create.blade.php -->

<h1>Create Post</h1>

@if ($errors->any())
    <div class="alert alert-danger">
        <ul>
            @foreach ($errors->all() as $error)
                <li>{{ $error }}</li>
            @endforeach
        </ul>
    </div>
@endif

<!-- Create Post Form -->

自訂錯誤訊息

Laravel 內建的每個驗證規則都有一個錯誤訊息，位於應用程式的 lang/en/validation.php 檔案中。如果您的應用程式沒有 lang 目錄，您可以使用 lang:publish Artisan 指令要求 Laravel 建立它。

在 lang/en/validation.php 檔案中，您會發現每個驗證規則的翻譯項目。您可以根據應用程式的需求自由更改或修改這些訊息。

此外，您可以將此檔案複製到另一個語言目錄，以便為應用程式的語言翻譯訊息。要了解更多關於 Laravel 在地化的資訊，請參閱完整的在地化文件。

⚠️ 警告

預設情況下，Laravel 應用程式骨架不包含 lang 目錄。如果您想自訂 Laravel 的語言檔案，可以透過 lang:publish Artisan 指令發布它們。

XHR 請求與驗證

在此範例中，我們使用了傳統表單將資料傳送到應用程式。然而，許多應用程式會接收來自 JavaScript 驅動前端的 XHR 請求。在 XHR 請求期間使用 validate 方法時，Laravel 不會產生重新導向回應。取而代之的是，Laravel 會產生一個包含所有驗證錯誤的 JSON 回應。此 JSON 回應將以 422 HTTP 狀態碼傳送。

`@error` 指令

您可以使用 @error Blade 指令快速判斷是否存在給定屬性的驗證錯誤訊息。在 @error 指令中，您可以印出 $message 變數來顯示錯誤訊息：

blade

<!-- /resources/views/post/create.blade.php -->

<label for="title">Post Title</label>

<input
    id="title"
    type="text"
    name="title"
    class="@error('title') is-invalid @enderror"
/>

@error('title')
    <div class="alert alert-danger">{{ $message }}</div>
@enderror

如果您使用的是命名的錯誤包 (Error Bags)，可以將錯誤包的名稱作為第二個參數傳遞給 @error 指令：

blade

<input ... class="@error('title', 'post') is-invalid @enderror">

重新填入表單

當 Laravel 因驗證錯誤產生重新導向回應時，框架會自動將所有的請求輸入資料快閃 (Flash) 到 Session 中。這樣做是為了讓您可以方便地在下一次請求期間存取輸入資料，並重新填入使用者嘗試提交的表單。

若要從上一次請求中取得快閃的輸入資料，請在 Illuminate\Http\Request 的實例上呼叫 old 方法。old 方法將從 Session 中取出先前快閃的輸入資料：

php

$title = $request->old('title');

Laravel 還提供了一個全域的 old 輔助函式。如果您是在 Blade 模板中顯示舊的輸入資料，使用 old 輔助函式來重新填入表單會更方便。如果給定欄位不存在舊的輸入資料，則會回傳 null：

blade

<input type="text" name="title" value="{{ old('title') }}">

關於選填欄位的注意事項

預設情況下，Laravel 在應用程式的全域中介層堆疊中包含 TrimStrings 和 ConvertEmptyStringsToNull 中介層。因此，如果您不希望驗證器將 null 值視為無效，通常需要將「選填」請求欄位標記為 nullable。例如：

php

$request->validate([
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
    'publish_at' => 'nullable|date',
]);

在此範例中，我們指定 publish_at 欄位可以是 null 或有效的日期表示形式。如果未在規則定義中加入 nullable 修飾詞，驗證器會將 null 視為無效日期。

驗證錯誤回應格式

當您的應用程式拋出 Illuminate\Validation\ValidationException 例外且傳入的 HTTP 請求預期獲得 JSON 回應時，Laravel 將自動為您格式化錯誤訊息，並回傳 422 Unprocessable Entity HTTP 回應。

您可以在下方查看驗證錯誤的 JSON 回應格式範例。請注意，巢狀錯誤鍵會被扁平化為「點 (dot)」記法格式：

json

{
    "message": "The team name must be a string. (and 4 more errors)",
    "errors": {
        "team_name": [
            "The team name must be a string.",
            "The team name must be at least 1 characters."
        ],
        "authorization.role": [
            "The selected authorization.role is invalid."
        ],
        "users.0.email": [
            "The users.0.email field is required."
        ],
        "users.2.email": [
            "The users.2.email must be a valid email address."
        ]
    }
}

Form Request 驗證

建立 Form Request

對於更複雜的驗證情境，您可能希望建立一個「Form Request」。Form Request 是自定義的請求類別，其中封裝了自身的驗證與授權邏輯。要建立一個 Form Request 類別，您可以使用 make:request Artisan CLI 命令：

shell

php artisan make:request StorePostRequest

產生的 Form Request 類別將放置在 app/Http/Requests 目錄中。如果該目錄不存在，在您執行 make:request 命令時會自動建立。Laravel 產生的每個 Form Request 都有兩個方法：authorize 和 rules。

正如您所料，authorize 方法負責判斷當前通過身份驗證的使用者是否可以執行該請求所代表的操作，而 rules 方法則回傳應套用於請求資料的驗證規則：

php

/**
 * Get the validation rules that apply to the request.
 *
 * @return array<string, \Illuminate\Contracts\Validation\ValidationRule|array<mixed>|string>
 */
public function rules(): array
{
    return [
        'title' => 'required|unique:posts|max:255',
        'body' => 'required',
    ];
}

📌 備註

您可以在 rules 方法的參數中使用型別提示 (Type-hint) 來注入任何所需的依賴項目。它們將自動透過 Laravel 服務容器進行解析。

那麼，驗證規則是如何評估的呢？您只需要在控制器方法中對該請求進行型別提示即可。傳入的 Form Request 會在控制器方法被呼叫之前進行驗證，這意味著您不需要在控制器中撰寫任何驗證邏輯：

php

/**
 * Store a new blog post.
 */
public function store(StorePostRequest $request): RedirectResponse
{
    // The incoming request is valid...

    // Retrieve the validated input data...
    $validated = $request->validated();

    // Retrieve a portion of the validated input data...
    $validated = $request->safe()->only(['name', 'email']);
    $validated = $request->safe()->except(['name', 'email']);

    // Store the blog post...

    return redirect('/posts');
}

如果驗證失敗，將會產生一個重新導向回應，將使用者送回先前的位置。錯誤訊息也會被快閃 (Flash) 到 Session 中，以便顯示。如果請求是 XHR 請求，則會回傳一個包含驗證錯誤的 JSON 格式的 422 狀態碼 HTTP 回應。

📌 備註

需要為您使用 Inertia 驅動的 Laravel 前端加入即時的 Form Request 驗證嗎？請參考 Laravel Precognition。

進行額外的驗證

有時您需要在初始驗證完成後執行額外的驗證。您可以使用 Form Request 的 after 方法來完成此操作。

after 方法應回傳一個由可呼叫物件 (callables) 或閉包 (closures) 組成的陣列，這些內容將在驗證完成後被呼叫。傳入的可呼叫物件將接收一個 Illuminate\Validation\Validator 實例，讓您可以在必要時增加額外的錯誤訊息：

php

use Illuminate\Validation\Validator;

/**
 * Get the "after" validation callables for the request.
 */
public function after(): array
{
    return [
        function (Validator $validator) {
            if ($this->somethingElseIsInvalid()) {
                $validator->errors()->add(
                    'field',
                    'Something is wrong with this field!'
                );
            }
        }
    ];
}

如上所述，after 方法回傳的陣列也可以包含可呼叫類別 (invokable classes)。這些類別的 __invoke 方法將接收一個 Illuminate\Validation\Validator 實例：

php

use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;
use Illuminate\Validation\Validator;

/**
 * Get the "after" validation callables for the request.
 */
public function after(): array
{
    return [
        new ValidateUserStatus,
        new ValidateShippingTime,
        function (Validator $validator) {
            //
        }
    ];
}

在第一個驗證失敗時停止

藉由在您的請求類別中加入 stopOnFirstFailure 屬性，您可以通知驗證器一旦發生單一驗證失敗，就應停止驗證所有屬性：

php

/**
 * Indicates if the validator should stop on the first rule failure.
 *
 * @var bool
 */
protected $stopOnFirstFailure = true;

自訂重新導向位置

當 Form Request 驗證失敗時，會產生一個重新導向回應，將使用者送回先前的位置。不過，您可以自由地自訂此行為。要做到這一點，請在您的 Form Request 中定義一個 $redirect 屬性：

php

/**
 * The URI that users should be redirected to if validation fails.
 *
 * @var string
 */
protected $redirect = '/dashboard';

或者，如果您想將使用者重新導向到一個命名路由，可以改為定義 $redirectRoute 屬性：

php

/**
 * The route that users should be redirected to if validation fails.
 *
 * @var string
 */
protected $redirectRoute = 'dashboard';

授權 Form Request

Form Request 類別也包含一個 authorize 方法。在此方法中，您可以判斷通過身份驗證的使用者是否真的有權限更新給定的資源。例如，您可以判斷使用者是否真的擁有他們正嘗試更新的部落格留言。您很可能會在此方法中與您的授權 Gate 與 Policy 互動：

php

use App\Models\Comment;

/**
 * Determine if the user is authorized to make this request.
 */
public function authorize(): bool
{
    $comment = Comment::find($this->route('comment'));

    return $comment && $this->user()->can('update', $comment);
}

由於所有的 Form Request 都繼承了 Laravel 的基礎請求類別，我們可以使用 user 方法來存取當前通過身份驗證的使用者。另外，請注意上面範例中對 route 方法的呼叫。此方法讓您可以存取正在被呼叫的路由上定義的 URI 參數，例如下方範例中的 {comment} 參數：

php

Route::post('/comment/{comment}');

因此，如果您的應用程式正在利用路由模型綁定 (Route Model Binding)，透過將解析後的模型作為請求的屬性來存取，您的程式碼甚至可以變得更加簡潔：

php

return $this->user()->can('update', $this->comment);

如果 authorize 方法回傳 false，則會自動回傳一個 403 狀態碼的 HTTP 回應，且您的控制器方法將不會執行。

如果您計畫在應用程式的其他部分處理請求的授權邏輯，您可以完全移除 authorize 方法，或者直接回傳 true：

php

/**
 * Determine if the user is authorized to make this request.
 */
public function authorize(): bool
{
    return true;
}

📌 備註

您可以在 authorize 方法的參數中使用型別提示來注入任何所需的依賴項目。它們將自動透過 Laravel 服務容器進行解析。

自訂錯誤訊息

您可以透過覆寫 messages 方法來針對 Form Request 所使用的錯誤訊息進行自訂。此方法應該回傳一個包含屬性/規則配對及其對應錯誤訊息的陣列：

php

/**
 * Get the error messages for the defined validation rules.
 *
 * @return array<string, string>
 */
public function messages(): array
{
    return [
        'title.required' => 'A title is required',
        'body.required' => 'A message is required',
    ];
}

自訂驗證屬性名稱

許多 Laravel 內建的驗證規則錯誤訊息都包含一個 :attribute 佔位符。如果您希望將驗證訊息中的 :attribute 佔位符替換為自訂的屬性名稱，可以透過覆寫 attributes 方法來指定自訂名稱。此方法應該回傳一個包含屬性/名稱配對的陣列：

php

/**
 * Get custom attributes for validator errors.
 *
 * @return array<string, string>
 */
public function attributes(): array
{
    return [
        'email' => 'email address',
    ];
}

準備驗證所需的輸入資料

如果您在套用驗證規則之前需要對請求中的任何資料進行準備或清理，可以使用 prepareForValidation 方法：

php

use Illuminate\Support\Str;

/**
 * Prepare the data for validation.
 */
protected function prepareForValidation(): void
{
    $this->merge([
        'slug' => Str::slug($this->slug),
    ]);
}

同樣地，如果您需要在驗證完成後對任何請求資料進行正規化，可以使用 passedValidation 方法：

php

/**
 * Handle a passed validation attempt.
 */
protected function passedValidation(): void
{
    $this->replace(['name' => 'Taylor']);
}

手動建立驗證器

如果您不想在請求上使用 validate 方法，您可以使用 Validator Facade 手動建立驗證器實例。該 Facade 上的 make 方法會產生一個新的驗證器實例：

php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Validator;

class PostController extends Controller
{
    /**
     * Store a new blog post.
     */
    public function store(Request $request): RedirectResponse
    {
        $validator = Validator::make($request->all(), [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
        ]);

        if ($validator->fails()) {
            return redirect('/post/create')
                ->withErrors($validator)
                ->withInput();
        }

        // Retrieve the validated input...
        $validated = $validator->validated();

        // Retrieve a portion of the validated input...
        $validated = $validator->safe()->only(['name', 'email']);
        $validated = $validator->safe()->except(['name', 'email']);

        // Store the blog post...

        return redirect('/posts');
    }
}

傳遞給 make 方法的第一個參數是待驗證的資料。第二個參數是應套用於該資料的驗證規則陣列。

在判斷請求驗證是否失敗後，您可以使用 withErrors 方法將錯誤訊息快閃 (Flash) 到 Session 中。使用此方法時，$errors 變數在重新導向後會自動與您的視圖共用，讓您能輕鬆地將其顯示給使用者。withErrors 方法接受驗證器、MessageBag 或 PHP array。

在第一個驗證失敗時停止

stopOnFirstFailure 方法將告知驗證器，一旦發生單一驗證失敗，就應停止驗證所有屬性：

php

if ($validator->stopOnFirstFailure()->fails()) {
    // ...
}

自動重新導向

如果您想手動建立驗證器實例，但仍想利用 HTTP 請求的 validate 方法提供的自動重新導向功能，您可以在現有的驗證器實例上呼叫 validate 方法。如果驗證失敗，使用者將自動被重新導向，或者在 XHR 請求的情況下，將會回傳 JSON 回應：

php

Validator::make($request->all(), [
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
])->validate();

如果驗證失敗，您可以使用 validateWithBag 方法將錯誤訊息儲存在命名的錯誤包 (Error Bag) 中：

php

Validator::make($request->all(), [
    'title' => 'required|unique:posts|max:255',
    'body' => 'required',
])->validateWithBag('post');

命名的錯誤包 (Error Bags)

如果您的單一頁面中有多個表單，您可能希望為包含驗證錯誤的 MessageBag 命名，以便您檢索特定表單的錯誤訊息。要達成此目的，請將名稱作為第二個參數傳遞給 withErrors：

php

return redirect('/register')->withErrors($validator, 'login');

接著您就可以從 $errors 變數中存取命名的 MessageBag 實例：

blade

{{ $errors->login->first('email') }}

自訂錯誤訊息

如果需要，您可以提供自訂錯誤訊息，供驗證器實例使用，以取代 Laravel 提供的預設錯誤訊息。有幾種指定自訂訊息的方法。首先，您可以將自訂訊息作為第三個參數傳遞給 Validator::make 方法：

php

$validator = Validator::make($input, $rules, $messages = [
    'required' => 'The :attribute field is required.',
]);

在此範例中，:attribute 佔位符將被驗證中欄位的實際名稱所取代。您也可以在驗證訊息中使用其他佔位符。例如：

php

$messages = [
    'same' => 'The :attribute and :other must match.',
    'size' => 'The :attribute must be exactly :size.',
    'between' => 'The :attribute value :input is not between :min - :max.',
    'in' => 'The :attribute must be one of the following types: :values',
];

為指定屬性指定自訂訊息

有時您可能希望僅為特定屬性指定自訂錯誤訊息。您可以使用「點 (dot)」標記法來做到這一點。先指定屬性的名稱，接著是規則：

php

$messages = [
    'email.required' => 'We need to know your email address!',
];

指定自訂屬性名稱

許多 Laravel 內建的錯誤訊息都包含一個 :attribute 佔位符，它會被驗證中的欄位或屬性名稱取代。若要自訂特定欄位取代這些佔位符的名稱，您可以將自訂屬性陣列作為第四個參數傳遞給 Validator::make 方法：

php

$validator = Validator::make($input, $rules, $messages, [
    'email' => 'email address',
]);

進行額外的驗證

有時您需要在初始驗證完成後執行額外的驗證。您可以使用驗證器的 after 方法來達成此目的。after 方法接受一個 Closure 或一個 Callable 陣列，它們將在驗證完成後被呼叫。給定的 Callable 將接收一個 Illuminate\Validation\Validator 實例，讓您在必要時增加額外的錯誤訊息：

php

use Illuminate\Support\Facades\Validator;

$validator = Validator::make(/* ... */);

$validator->after(function ($validator) {
    if ($this->somethingElseIsInvalid()) {
        $validator->errors()->add(
            'field', 'Something is wrong with this field!'
        );
    }
});

if ($validator->fails()) {
    // ...
}

如前所述，after 方法也接受一個 Callable 陣列，如果您的「驗證後」邏輯封裝在可呼叫的 (Invokable) 類別中，這會特別方便，這些類別將透過其 __invoke 方法接收 Illuminate\Validation\Validator 實例：

php

use App\Validation\ValidateShippingTime;
use App\Validation\ValidateUserStatus;

$validator->after([
    new ValidateUserStatus,
    new ValidateShippingTime,
    function ($validator) {
        // ...
    },
]);

使用驗證過的輸入資料

在使用 Form Request 或手動建立的驗證器實例驗證傳入的請求資料後，您可能希望取得實際經過驗證的傳入請求資料。這可以透過幾種方式完成。首先，您可以呼叫 Form Request 或驗證器實例上的 validated 方法。此方法會回傳一個包含已驗證資料的陣列：

php

$validated = $request->validated();

$validated = $validator->validated();

另外，您也可以呼叫 Form Request 或驗證器實例上的 safe 方法。此方法會回傳一個 Illuminate\Support\ValidatedInput 的實例。此物件提供了 only、except 與 all 方法，用於取得已驗證資料的子集或整個已驗證資料陣列：

php

$validated = $request->safe()->only(['name', 'email']);

$validated = $request->safe()->except(['name', 'email']);

$validated = $request->safe()->all();

此外，Illuminate\Support\ValidatedInput 實例可以被迭代，並且能像陣列一樣被存取：

php

// Validated data may be iterated...
foreach ($request->safe() as $key => $value) {
    // ...
}

// Validated data may be accessed as an array...
$validated = $request->safe();

$email = $validated['email'];

如果您想在已驗證的資料中加入額外的欄位，可以呼叫 merge 方法：

php

$validated = $request->safe()->merge(['name' => 'Taylor Otwell']);

如果您想將已驗證的資料以 Collection (集合) 實例的形式取得，可以呼叫 collect 方法：

php

$collection = $request->safe()->collect();

使用錯誤訊息

在呼叫 Validator 實例上的 errors 方法後，您將會收到一個 Illuminate\Support\MessageBag 實例，它具有多種方便的方法來處理錯誤訊息。自動提供給所有視圖的 $errors 變數也是 MessageBag 類別的一個實例。

取得欄位的第一條錯誤訊息

要取得給定欄位的第一條錯誤訊息，請使用 first 方法：

php

$errors = $validator->errors();

echo $errors->first('email');

取得欄位的所有錯誤訊息

如果您需要取得給定欄位所有訊息的陣列，請使用 get 方法：

php

foreach ($errors->get('email') as $message) {
    // ...
}

如果您正在驗證一個陣列形式的表單欄位，可以使用 * 字元來取得每個陣列元素的所有訊息：

php

foreach ($errors->get('attachments.*') as $message) {
    // ...
}

取得所有欄位的所有錯誤訊息

要取得所有欄位的所有訊息陣列，請使用 all 方法：

php

foreach ($errors->all() as $message) {
    // ...
}

判斷欄位是否存在訊息

has 方法可用於判斷給定欄位是否存在任何錯誤訊息：

php

if ($errors->has('email')) {
    // ...
}

在語言檔中指定自訂訊息

Laravel 內建的每個驗證規則都有一個錯誤訊息，位於應用程式的 lang/en/validation.php 檔案中。如果您的應用程式沒有 lang 目錄，您可以使用 lang:publish Artisan 指令來指示 Laravel 建立它。

在 lang/en/validation.php 檔案中，您會發現每個驗證規則的翻譯項目。您可以根據應用程式的需求隨意更改或修改這些訊息。

此外，您可以將此檔案複製到另一個語言目錄，為您的應用程式語言翻譯訊息。要瞭解更多關於 Laravel 在地化 (Localization) 的資訊，請參閱完整的在地化文件。

⚠️ 警告

預設情況下，Laravel 應用程式骨架不包含 lang 目錄。如果您想要自訂 Laravel 的語言檔，可以透過 lang:publish Artisan 指令來發布它們。

特定屬性的自訂訊息

您可以在應用程式的驗證語言檔中，為特定的屬性與規則組合自訂錯誤訊息。為此，請將您的自訂訊息新增至應用程式 lang/xx/validation.php 語言檔中的 custom 陣列：

php

'custom' => [
    'email' => [
        'required' => 'We need to know your email address!',
        'max' => 'Your email address is too long!'
    ],
],

在語言檔中指定屬性名稱

許多 Laravel 內建的錯誤訊息都包含一個 :attribute 佔位符，它會被替換為正在驗證的欄位或屬性名稱。如果您希望驗證訊息中的 :attribute 部分被替換為自訂值，您可以在 lang/xx/validation.php 語言檔的 attributes 陣列中指定自訂屬性名稱：

php

'attributes' => [
    'email' => 'email address',
],

⚠️ 警告

預設情況下，Laravel 應用程式骨架不包含 lang 目錄。如果您想要自訂 Laravel 的語言檔，可以透過 lang:publish Artisan 指令來發布它們。

在語言檔中指定值

某些 Laravel 內建驗證規則的錯誤訊息包含一個 :value 佔位符，它會被替換為請求屬性的目前值。然而，您有時可能需要將驗證訊息中的 :value 部分替換為該值的自訂表示方式。例如，考慮以下規則，它指定如果 payment_type 的值為 cc，則需要信用卡卡號：

php

Validator::make($request->all(), [
    'credit_card_number' => 'required_if:payment_type,cc'
]);

如果此驗證規則失敗，它將產生以下錯誤訊息：

text

The credit card number field is required when payment type is cc.

除了將 cc 顯示為支付類型的值之外，您還可以在 lang/xx/validation.php 語言檔中定義 values 陣列，來指定更具親和力的值表示方式：

php

'values' => [
    'payment_type' => [
        'cc' => 'credit card'
    ],
],

⚠️ 警告

預設情況下，Laravel 應用程式骨架不包含 lang 目錄。如果您想要自訂 Laravel 的語言檔，可以透過 lang:publish Artisan 指令來發布它們。

定義此值後，驗證規則將產生以下錯誤訊息：

text

The credit card number field is required when payment type is credit card.

可用的驗證規則

以下是所有可用的驗證規則及其功能的清單：

布林值

Accepted Accepted If Boolean Declined Declined If

字串

公用程式

accepted

被驗證的欄位必須為 "yes"、"on"、1、"1"、true 或 "true"。這在驗證「服務條款」的同意或類似欄位時非常有用。

accepted_if:anotherfield,value,...

若另一個被驗證的欄位等於指定的值，則此被驗證的欄位必須為 "yes"、"on"、1、"1"、true 或 "true"。這在驗證「服務條款」的同意或類似欄位時非常有用。

active_url

被驗證的欄位必須根據 PHP 函數 dns_get_record 具有有效的 A 或 AAAA 記錄。在傳遞給 dns_get_record 之前，會先使用 PHP 函數 parse_url 提取提供網址的主機名稱。

after:date

被驗證的欄位必須是一個在給定日期之後的值。日期將被傳遞到 PHP 的 strtotime 函數，以便轉換為有效的 DateTime 實例：

php

'start_date' => 'required|date|after:tomorrow'

您可以指定另一個欄位來與日期進行比較，而不是傳遞一個由 strtotime 評估的日期字串：

php

'finish_date' => 'required|date|after:start_date'

為了方便起見，可以使用流暢的 date 規則建構器來建立基於日期的規則：

php

use Illuminate\Validation\Rule;

'start_date' => [
    'required',
    Rule::date()->after(today()->addDays(7)),
],

afterToday 和 todayOrAfter 方法可用於流暢地表達日期，分別必須在今天之後，或今天或今天之後：

php

'start_date' => [
    'required',
    Rule::date()->afterToday(),
],

after_or_equal:date

被驗證的欄位必須是一個在給定日期之後或等於該日期的值。更多資訊請參閱 after 規則。

為了方便起見，可以使用流暢的 date 規則建構器來建立基於日期的規則：

php

use Illuminate\Validation\Rule;

'start_date' => [
    'required',
    Rule::date()->afterOrEqual(today()->addDays(7)),
],

anyOf

Rule::anyOf 驗證規則允許您指定被驗證的欄位必須符合任何給定的驗證規則集。例如，以下規則將驗證 username 欄位必須是電子郵件地址，或者是長度至少為 6 個字元的英數字串（包含連字號）：

php

use Illuminate\Validation\Rule;

'username' => [
    'required',
    Rule::anyOf([
        ['string', 'email'],
        ['string', 'alpha_dash', 'min:6'],
    ]),
],

alpha

被驗證的欄位必須完全是由包含在 \p{L} 與 \p{M} 中的 Unicode 字母字元組成。

若要將此驗證規則限制在 ASCII 範圍內（a-z 和 A-Z），您可以為驗證規則提供 ascii 選項：

php

'username' => 'alpha:ascii',

alpha_dash

待驗證欄位必須完全由 \p{L}、\p{M}、\p{N} 中包含的 Unicode 字母數字字元，以及 ASCII 破折號 (-) 和 ASCII 底線 (_) 組成。

為了將此驗證規則限制在 ASCII 範圍內 (a-z、A-Z 和 0-9)，您可以為驗證規則提供 ascii 選項：

php

'username' => 'alpha_dash:ascii',

alpha_num

待驗證欄位必須完全由 \p{L}、\p{M} 和 \p{N} 中包含的 Unicode 字母數字字元組成。

為了將此驗證規則限制在 ASCII 範圍內 (a-z、A-Z 和 0-9)，您可以為驗證規則提供 ascii 選項：

php

'username' => 'alpha_num:ascii',

array

待驗證欄位必須是一個 PHP array。

當為 array 規則提供額外的值時，輸入陣列中的每個鍵 (Key) 都必須存在於提供給該規則的值清單中。在以下範例中，輸入陣列中的 admin 鍵是無效的，因為它不包含在提供給 array 規則的值清單中：

php

use Illuminate\Support\Facades\Validator;

$input = [
    'user' => [
        'name' => 'Taylor Otwell',
        'username' => 'taylorotwell',
        'admin' => true,
    ],
];

Validator::make($input, [
    'user' => 'array:name,username',
]);

一般來說，您應該始終指定陣列中允許存在的鍵。

ascii

待驗證欄位必須完全由 7 位元 (7-bit) ASCII 字元組成。

bail

在該欄位遇到第一個驗證失敗後，停止執行該欄位的其餘驗證規則。

雖然 bail 規則僅會在遇到驗證失敗時停止驗證特定欄位，但 stopOnFirstFailure 方法將通知驗證器，一旦發生單一驗證失敗，就應停止驗證所有屬性：

php

if ($validator->stopOnFirstFailure()->fails()) {
    // ...
}

before:date

待驗證欄位必須是早於給定日期的一個值。這些日期將傳遞給 PHP 的 strtotime 函數，以便轉換為有效的 DateTime 實例。此外，與 after 規則類似，可以提供另一個待驗證欄位的名稱作為 date 的值。

為了方便起見，也可以使用流暢的 date 規則構建器來構建基於日期的規則：

php

use Illuminate\Validation\Rule;

'start_date' => [
    'required',
    Rule::date()->before(today()->subDays(7)),
],

beforeToday 和 todayOrBefore 方法可用於流暢地表達日期，且必須分別在今天之前，或今天或今天之前：

php

'start_date' => [
    'required',
    Rule::date()->beforeToday(),
],

before_or_equal:date

待驗證欄位必須是早於或等於給定日期的值。這些日期將傳遞給 PHP 的 strtotime 函數，以便轉換為有效的 DateTime 實例。此外，與 after 規則類似，可以提供另一個待驗證欄位的名稱作為 date 的值。

為了方便起見，也可以使用流暢的 date 規則構建器來構建基於日期的規則：

php

use Illuminate\Validation\Rule;

'start_date' => [
    'required',
    Rule::date()->beforeOrEqual(today()->subDays(7)),
],

between:min,max

待驗證欄位的大小必須介於指定的 min 與 max 之間（含）。字串、數值、陣列和檔案的評估方式與 size 規則相同。

boolean

待驗證欄位必須能夠被轉換為布林值。接受的輸入為 true、false、1、0、"1" 和 "0"。

您可以使用 strict 參數，僅在欄位值為 true 或 false 時才視為有效：

php

'foo' => 'boolean:strict'

confirmed

待驗證欄位必須有一個相符的 {field}_confirmation 欄位。例如，如果待驗證欄位是 password，則輸入資料中必須存在一個相符的 password_confirmation 欄位。

您也可以傳入自訂的確認欄位名稱。例如，confirmed:repeat_username 將預期 repeat_username 欄位與待驗證欄位相符。

contains:foo,bar,...

待驗證欄位必須是一個包含所有指定參數值的陣列。由於此規則通常需要您 implode 一個陣列，因此可以使用 Rule::contains 方法來流暢地構建該規則：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'roles' => [
        'required',
        'array',
        Rule::contains(['admin', 'editor']),
    ],
]);

doesnt_contain:foo,bar,...

待驗證欄位必須是一個不包含任何指定參數值的陣列。由於此規則通常需要您 implode 一個陣列，因此可以使用 Rule::doesntContain 方法來流暢地構建該規則：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'roles' => [
        'required',
        'array',
        Rule::doesntContain(['admin', 'editor']),
    ],
]);

current_password

待驗證欄位必須與目前已驗證使用者的密碼相符。您可以使用規則的第一個參數指定一個驗證守衛 (Authentication Guard)：

php

'password' => 'current_password:api'

date

根據 PHP 的 strtotime 函數，待驗證欄位必須是一個有效的、非相對的日期。

date_equals:date

待驗證欄位必須等於給定的日期。這些日期將傳遞給 PHP 的 strtotime 函數，以便轉換為有效的 DateTime 實例。

date_format:format,...

待驗證欄位必須符合給定的格式之一。在驗證欄位時，您應該使用 date 或 date_format 其中之一，而不是兩者都用。此驗證規則支援 PHP DateTime 類別支援的所有格式。

為了方便起見，可以使用流暢的 date 規則構建器來構建基於日期的規則：

php

use Illuminate\Validation\Rule;

'start_date' => [
    'required',
    Rule::date()->format('Y-m-d'),
],

decimal:min,max

待驗證欄位必須為數值，且必須包含指定數量的小數位：

php

// Must have exactly two decimal places (9.99)...
'price' => 'decimal:2'

// Must have between 2 and 4 decimal places...
'price' => 'decimal:2,4'

declined

待驗證欄位必須為 "no"、"off"、0、"0"、false 或 "false"。

declined_if:anotherfield,value,...

如果另一個待驗證欄位等於指定的值，則待驗證欄位必須為 "no"、"off"、0、"0"、false 或 "false"。

different:field

待驗證欄位的值必須與 field 不同。

digits:value

待驗證的整數必須具有確切的長度 value。

digits_between:min,max

待驗證的整數長度必須在給定的 min 與 max 之間。

dimensions

待驗證的檔案必須是符合規則參數所指定尺寸限制的圖片：

php

'avatar' => 'dimensions:min_width=100,min_height=200'

可用的限制有：min_width、max_width、min_height、max_height、width、height、ratio。

ratio 限制應表示為寬度除以高度。這可以透過分數（如 3/2）或浮點數（如 1.5）來指定：

php

'avatar' => 'dimensions:ratio=3/2'

由於此規則需要多個參數，因此通常使用 Rule::dimensions 方法來流暢地建構規則會更方便：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'avatar' => [
        'required',
        Rule::dimensions()
            ->maxWidth(1000)
            ->maxHeight(500)
            ->ratio(3 / 2),
    ],
]);

distinct

當驗證陣列時，待驗證的欄位不得有任何重複的值：

php

'foo.*.id' => 'distinct'

預設情況下，Distinct 使用寬鬆的變數比較。若要使用嚴格比較，您可以在驗證規則定義中加入 strict 參數：

php

'foo.*.id' => 'distinct:strict'

您可以在驗證規則的參數中加入 ignore_case，使該規則忽略大小寫差異：

php

'foo.*.id' => 'distinct:ignore_case'

doesnt_start_with:foo,bar,...

待驗證的欄位不得以給定的任一值開頭。

doesnt_end_with:foo,bar,...

待驗證的欄位不得以給定的任一值結尾。

email

待驗證的欄位格式必須為電子郵件地址。此驗證規則利用 egulias/email-validator 套件來驗證電子郵件地址。預設會套用 RFCValidation 驗證器，但您也可以套用其他驗證樣式：

php

'email' => 'email:rfc,dns'

上述範例將套用 RFCValidation 與 DNSCheckValidation 驗證。以下是您可以套用的完整驗證樣式列表：

rfc: RFCValidation - 根據受支援的 RFC 驗證電子郵件地址。
strict: NoRFCWarningsValidation - 根據受支援的 RFC 驗證電子郵件，並在發現警告（例如結尾句點和多個連續句點）時驗證失敗。
dns: DNSCheckValidation - 確保電子郵件地址的網域具有有效的 MX 記錄。
spoof: SpoofCheckValidation - 確保電子郵件地址不包含同形文字或具欺騙性的 Unicode 字元。
filter: FilterEmailValidation - 根據 PHP 的 filter_var 函式確保電子郵件地址有效。
filter_unicode: FilterEmailValidation::unicode() - 根據 PHP 的 filter_var 函式確保電子郵件地址有效，並允許某些 Unicode 字元。

為了方便起見，可以使用流暢的規則建構器來建立電子郵件驗證規則：

php

use Illuminate\Validation\Rule;

$request->validate([
    'email' => [
        'required',
        Rule::email()
            ->rfcCompliant(strict: false)
            ->validateMxRecord()
            ->preventSpoofing()
    ],
]);

⚠️ 警告

dns 與 spoof 驗證器需要 PHP intl 擴充功能。

encoding:encoding_type

待驗證的欄位必須符合指定的字元編碼。此規則使用 PHP 的 mb_check_encoding 函式來驗證給定檔案或字串值的編碼。為了方便起見，可以使用 Laravel 流暢的檔案規則建構器來建構 encoding 規則：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\File;

Validator::validate($input, [
    'attachment' => [
        'required',
        File::types(['csv'])
            ->encoding('utf-8'),
    ],
]);

ends_with:foo,bar,...

待驗證的欄位必須以給定的任一值結尾。

enum

Enum 規則是一個基於類別的規則，用於驗證待驗證的欄位是否包含有效的 Enum 值。Enum 規則接受 Enum 的名稱作為其唯一的建構子參數。當驗證原始值時，應向 Enum 規則提供一個背後帶值型 Enum (Backed Enum)：

php

use App\Enums\ServerStatus;
use Illuminate\Validation\Rule;

$request->validate([
    'status' => [Rule::enum(ServerStatus::class)],
]);

Enum 規則的 only 與 except 方法可用於限制哪些 Enum 案例應被視為有效：

php

Rule::enum(ServerStatus::class)
    ->only([ServerStatus::Pending, ServerStatus::Active]);

Rule::enum(ServerStatus::class)
    ->except([ServerStatus::Pending, ServerStatus::Active]);

when 方法可用於依條件修改 Enum 規則：

php

use Illuminate\Support\Facades\Auth;
use Illuminate\Validation\Rule;

Rule::enum(ServerStatus::class)
    ->when(
        Auth::user()->isAdmin(),
        fn ($rule) => $rule->only(...),
        fn ($rule) => $rule->only(...),
    );

exclude

待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除。

exclude_if:anotherfield,value

如果 anotherfield 欄位等於 value，則待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除。

若需要複雜的條件排除邏輯，您可以使用 Rule::excludeIf 方法。此方法接受一個布林值或一個閉包 (Closure)。當傳入閉包時，該閉包應回傳 true 或 false 以指示是否應排除待驗證的欄位：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($request->all(), [
    'role_id' => Rule::excludeIf($request->user()->is_admin),
]);

Validator::make($request->all(), [
    'role_id' => Rule::excludeIf(fn () => $request->user()->is_admin),
]);

exclude_unless:anotherfield,value

除非 anotherfield 欄位等於 value，否則待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除。若 value 為 null (exclude_unless:name,null)，除非比較欄位為 null 或請求資料中缺少比較欄位，否則待驗證的欄位將被排除。

exclude_with:anotherfield

如果 anotherfield 欄位存在，則待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除。

exclude_without:anotherfield

如果 anotherfield 欄位不存在，則待驗證的欄位將從 validate 與 validated 方法回傳的請求資料中排除。

exists:table,column

待驗證的欄位必須存在於給定的資料庫資料表中。

Exists 規則的基本用法

php

'state' => 'exists:states'

若未指定 column 選項，則將使用屬性名稱。因此在這種情況下，該規則將驗證 states 資料庫資料表中是否包含一筆記錄，其 state 欄位的值與請求的 state 屬性值相符。

指定自訂欄位名稱

您可以透過將資料庫欄位名稱放在資料庫資料表名稱之後，來明確指定驗證規則應使用的資料庫欄位名稱：

php

'state' => 'exists:states,abbreviation'

有時，您可能需要指定用於 exists 查詢的特定資料庫連線。您可以透過在資料表名稱前加上連線名稱來達成此目的：

php

'email' => 'exists:connection.staff,email'

除了直接指定資料表名稱外，您也可以指定應用於確定資料表名稱的 Eloquent 模型：

php

'user_id' => 'exists:App\Models\User,id'

如果您想自訂驗證規則執行的查詢，可以使用 Rule 類別來流暢地定義規則。在此範例中，我們還將驗證規則指定為陣列，而不是使用 | 字元來分隔它們：

php

use Illuminate\Database\Query\Builder;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'email' => [
        'required',
        Rule::exists('staff')->where(function (Builder $query) {
            $query->where('account_id', 1);
        }),
    ],
]);

您可以透過向 exists 方法提供欄位名稱作為第二個參數，來明確指定由 Rule::exists 方法生成的 exists 規則應使用的資料庫欄位名稱：

php

'state' => Rule::exists('states', 'abbreviation'),

有時，您可能希望驗證資料庫中是否存在陣列中的值。您可以透過將 exists 和 array 規則同時加到要驗證的欄位來達成此目的：

php

'states' => ['array', Rule::exists('states', 'abbreviation')],

當這兩個規則都分配給一個欄位時，Laravel 將自動建立單個查詢，以判斷所有指定的值是否存在於指定的資料表中。

extensions:foo,bar,...

待驗證的檔案必須具有對應於列表中的其中一個使用者指定副檔名：

php

'photo' => ['required', 'extensions:jpg,png'],

⚠️ 警告

您永遠不應僅依賴驗證檔案的使用者指定副檔名。此規則通常應始終與 mimes 或 mimetypes 規則結合使用。

file

待驗證的欄位必須是成功上傳的檔案。

filled

待驗證的欄位在存在時不得為空。

gt:field

待驗證的欄位必須大於指定的 field 或 value。這兩個欄位必須是相同的類型。字串、數值、陣列及檔案的評估方式與 size 規則相同。

gte:field

待驗證的欄位必須大於或等於指定的 field 或 value。這兩個欄位必須是相同的類型。字串、數值、陣列及檔案的評估方式與 size 規則相同。

hex_color

待驗證的欄位必須包含十六進位 (Hexadecimal) 格式的有效顏色值。

image

待驗證的檔案必須是圖片 (jpg, jpeg, png, bmp, gif, 或 webp)。

⚠️ 警告

預設情況下，image 規則不允許 SVG 檔案，因為可能存在 XSS 弱點。如果您需要允許 SVG 檔案，您可以提供 allow_svg 指令給 image 規則 (image:allow_svg)。

in:foo,bar,...

待驗證的欄位必須包含在指定的清單中。由於此規則通常需要您 implode 一個陣列，因此可以使用 Rule::in 方法來流暢地建構規則：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'zones' => [
        'required',
        Rule::in(['first-zone', 'second-zone']),
    ],
]);

當 in 規則與 array 規則結合使用時，輸入陣列中的每個值都必須存在於提供給 in 規則的值清單中。在以下範例中，輸入陣列中的 LAS 機場代碼是無效的，因為它未包含在提供給 in 規則的機場清單中：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

$input = [
    'airports' => ['NYC', 'LAS'],
];

Validator::make($input, [
    'airports' => [
        'required',
        'array',
    ],
    'airports.*' => Rule::in(['NYC', 'LIT']),
]);

in_array:anotherfield.*

待驗證的欄位必須存在於 anotherfield 的值中。

in_array_keys:value.*

待驗證的欄位必須是一個陣列，且該陣列中至少包含一個指定的 values 作為鍵名：

php

'config' => 'array|in_array_keys:timezone'

integer

待驗證的欄位必須是一個整數。

您可以使用 strict 參數，僅當欄位類型為 integer 時才視為有效。包含整數值的字串將被視為無效：

php

'age' => 'integer:strict'

⚠️ 警告

此驗證規則並非驗證輸入資料是否為「整數」變數類型，僅驗證輸入資料是否為 PHP 的 FILTER_VALIDATE_INT 規則所接受的類型。如果您需要驗證輸入資料是否為數字，請將此規則與 numeric 驗證規則結合使用。

ip

待驗證的欄位必須是一個 IP 位址。

ipv4

待驗證的欄位必須是一個 IPv4 位址。

ipv6

待驗證的欄位必須是一個 IPv6 位址。

json

待驗證的欄位必須是一個有效的 JSON 字串。

lt:field

待驗證的欄位必須小於指定的 field。這兩個欄位必須是相同的類型。字串、數值、陣列及檔案的評估方式與 size 規則相同。

lte:field

待驗證的欄位必須小於或等於指定的 field。這兩個欄位必須是相同的類型。字串、數值、陣列及檔案的評估方式與 size 規則相同。

lowercase

待驗證的欄位必須是小寫。

list

待驗證的欄位必須是一個身為列表 (List) 的陣列。如果一個陣列的鍵由 0 到 count($array) - 1 的連續數字組成，則被視為列表。

mac_address

待驗證的欄位必須是一個 MAC 位址。

max:value

待驗證的欄位必須小於或等於最大值 value。字串、數值、陣列及檔案的評估方式與 size 規則相同。

max_digits:value

待驗證的整數長度必須最大為 value。

mimetypes:text/plain,...

待驗證的檔案必須符合其中一個指定的 MIME 類型：

php

'video' => 'mimetypes:video/avi,video/mpeg,video/quicktime',

'media' => 'mimetypes:image/*,video/*',

為了確定上傳檔案的 MIME 類型，系統將讀取檔案內容，且框架會嘗試猜測其 MIME 類型，這可能與客戶端提供的 MIME 類型不同。

mimes:foo,bar,...

待驗證的檔案必須具有與所列副檔名之一對應的 MIME 類型：

php

'photo' => 'mimes:jpg,bmp,png'

雖然您只需要指定副檔名，但此規則實際上是透過讀取檔案內容並猜測其 MIME 類型來進行驗證。MIME 類型及其對應副檔名的完整列表可以在以下位置找到：

https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types

MIME 類型與副檔名

此驗證規則不會驗證 MIME 類型與使用者為檔案分配的副檔名之間是否一致。例如，mimes:png 驗證規則會將包含有效 PNG 內容的檔案視為有效的 PNG 圖片，即使該檔案被命名為 photo.txt。如果您想驗證使用者分配的檔案副檔名，可以使用 extensions 規則。

min:value

待驗證欄位的大小必須大於或等於最小值 value。字串、數字、陣列與檔案的評估方式與 size 規則相同。

min_digits:value

待驗證的整數長度必須至少為 value。

multiple_of:value

待驗證欄位必須是 value 的倍數。

missing

待驗證欄位在輸入資料中必須不存在。

missing_if:anotherfield,value,...

如果 anotherfield 欄位等於任何 value，則待驗證欄位必須不存在。

missing_unless:anotherfield,value

除非 anotherfield 欄位等於任何 value，否則待驗證欄位必須不存在。

missing_with:foo,bar,...

僅當任何其他指定的欄位存在時，待驗證欄位才必須不存在。

missing_with_all:foo,bar,...

僅當所有其他指定的欄位都存在時，待驗證欄位才必須不存在。

not_in:foo,bar,...

待驗證欄位不得包含在給定的值列表中。Rule::notIn 方法可用於以流暢的方式建構規則：

php

use Illuminate\Validation\Rule;

Validator::make($data, [
    'toppings' => [
        'required',
        Rule::notIn(['sprinkles', 'cherries']),
    ],
]);

not_regex:pattern

待驗證欄位不得符合給定的正規表示式。

在內部，此規則使用 PHP 的 preg_match 函數。指定的模式應遵循 preg_match 所需的相同格式，因此也包含有效的定界符。例如：'email' => 'not_regex:/^.+$/i'。

⚠️ 警告

當使用 regex / not_regex 模式時，可能需要使用陣列指定您的驗證規則，而不是使用 | 定界符，特別是如果正規表示式包含 | 字元。

nullable

待驗證欄位可以為 null。

numeric

待驗證欄位必須是數字 (numeric)。

您可以使用 strict 參數，僅在欄位值為整數或浮點數類型時才將該欄位視為有效。數字字串將被視為無效：

php

'amount' => 'numeric:strict'

present

待驗證欄位必須存在於輸入資料中。

present_if:anotherfield,value,...

如果 anotherfield 欄位等於任何 value，則待驗證欄位必須存在。

present_unless:anotherfield,value

除非 anotherfield 欄位等於任何 value，否則待驗證欄位必須存在。

present_with:foo,bar,...

僅當任何其他指定的欄位存在時，待驗證欄位才必須存在。

present_with_all:foo,bar,...

僅當所有其他指定的欄位都存在時，待驗證欄位才必須存在。

prohibited

待驗證欄位必須缺失或為空。如果欄位符合以下標準之一，則該欄位為「空」：

值為 null。
值為空字串。
值為空陣列或空的 Countable 物件。
值為路徑為空的已上傳檔案。

prohibited_if:anotherfield,value,...

如果 anotherfield 欄位等於任何 value，則待驗證欄位必須缺失或為空。如果欄位符合以下標準之一，則該欄位為「空」：

值為 null。
值為空字串。
值為空陣列或空的 Countable 物件。
值為路徑為空的已上傳檔案。

如果需要複雜的條件式禁用邏輯，可以使用 Rule::prohibitedIf 方法。此方法接受一個布林值或一個 Closure。當提供 Closure 時，該 Closure 應回傳 true 或 false 以指示是否應禁用待驗證欄位：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($request->all(), [
    'role_id' => Rule::prohibitedIf($request->user()->is_admin),
]);

Validator::make($request->all(), [
    'role_id' => Rule::prohibitedIf(fn () => $request->user()->is_admin),
]);

prohibited_if_accepted:anotherfield,...

如果 anotherfield 欄位等於 "yes"、"on"、1、"1"、true 或 "true"，則待驗證欄位必須缺失或為空。

prohibited_if_declined:anotherfield,...

如果 anotherfield 欄位等於 "no"、"off"、0、"0"、false 或 "false"，則待驗證欄位必須缺失或為空。

prohibited_unless:anotherfield,value,...

除非 anotherfield 欄位等於任何 value，否則待驗證欄位必須缺失或為空。如果欄位符合以下標準之一，則該欄位為「空」：

值為 null。
值為空字串。
值為空陣列或空的 Countable 物件。
值為路徑為空的已上傳檔案。

prohibits:anotherfield,...

如果待驗證欄位不是缺失或為空，則 anotherfield 中的所有欄位都必須缺失或為空。如果欄位符合以下標準之一，則該欄位為「空」：

值為 null。
值為空字串。
值為空陣列或空的 Countable 物件。
值為路徑為空的已上傳檔案。

regex:pattern

待驗證欄位必須符合給定的正規表示式。

在內部，此規則使用 PHP 的 preg_match 函數。指定的模式應遵循 preg_match 所需的相同格式，因此也包含有效的定界符。例如：'email' => 'regex:/^.+@.+$/i'。

⚠️ 警告

當使用 regex / not_regex 模式時，可能需要使用陣列指定規則，而不是使用 | 定界符，特別是如果正規表示式包含 | 字元。

required

待驗證欄位必須存在於輸入資料中且不為空。若符合以下任一條件，則該欄位被視為「空」：

值為 null。
值為空字串。
值為空陣列或空的 Countable 物件。
值為沒有路徑的已上傳檔案。

required_if:anotherfield,value,...

如果 anotherfield 欄位等於任何一個 value，則待驗證欄位必須存在且不為空。

如果你想為 required_if 規則構建更複雜的條件，你可以使用 Rule::requiredIf 方法。該方法接受一個布林值或一個 Closure。當傳遞一個 Closure 時，Closure 應該回傳 true 或 false 以指示待驗證欄位是否為必填：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($request->all(), [
    'role_id' => Rule::requiredIf($request->user()->is_admin),
]);

Validator::make($request->all(), [
    'role_id' => Rule::requiredIf(fn () => $request->user()->is_admin),
]);

required_if_accepted:anotherfield,...

如果 anotherfield 欄位等於 "yes"、"on"、1、"1"、true 或 "true"，則待驗證欄位必須存在且不為空。

required_if_declined:anotherfield,...

如果 anotherfield 欄位等於 "no"、"off"、0、"0"、false 或 "false"，則待驗證欄位必須存在且不為空。

required_unless:anotherfield,value,...

除非 anotherfield 欄位等於任何一個 value，否則待驗證欄位必須存在且不為空。這也意味著除非 value 為 null，否則 anotherfield 必須存在於請求資料中。如果 value 為 null (required_unless:name,null)，則待驗證欄位將是必填的，除非比較欄位為 null 或請求資料中缺少比較欄位。

required_with:foo,bar,...

「僅當」指定的其他任一欄位存在且不為空時，待驗證欄位才必須存在且不為空。

required_with_all:foo,bar,...

「僅當」指定的其他所有欄位都存在且不為空時，待驗證欄位才必須存在且不為空。

required_without:foo,bar,...

「僅當」指定的其他任一欄位為空或不存在時，待驗證欄位才必須存在且不為空。

required_without_all:foo,bar,...

「僅當」指定的其他所有欄位都為空或不存在時，待驗證欄位才必須存在且不為空。

required_array_keys:foo,bar,...

待驗證欄位必須是一個陣列，並且至少包含指定的鍵 (Key)。

same:field

給定的 field 必須與待驗證欄位匹配。

size:value

待驗證欄位的大小必須符合給定的 value。對於字串資料，value 對應於字元數。對於數值資料，value 對應於給定的整數值（該屬性也必須具有 numeric 或 integer 規則）。對於陣列，size 對應於陣列的 count。對於檔案，size 對應於檔案大小（以 KB 為單位）。讓我們看一些範例：

php

// Validate that a string is exactly 12 characters long...
'title' => 'size:12';

// Validate that a provided integer equals 10...
'seats' => 'integer|size:10';

// Validate that an array has exactly 5 elements...
'tags' => 'array|size:5';

// Validate that an uploaded file is exactly 512 kilobytes...
'image' => 'file|size:512';

starts_with:foo,bar,...

待驗證欄位必須以給定的其中一個值開頭。

string

待驗證欄位必須是一個字串。如果你想允許該欄位也可以為 null，你應該為該欄位分配 nullable 規則。

timezone

根據 DateTimeZone::listIdentifiers 方法，待驗證欄位必須是一個有效的時區識別碼。

DateTimeZone::listIdentifiers 方法接受的參數也可以提供給此驗證規則：

php

'timezone' => 'required|timezone:all';

'timezone' => 'required|timezone:Africa';

'timezone' => 'required|timezone:per_country,US';

unique:table,column

待驗證的欄位值不得存在於給定的資料庫資料表中。

指定自訂資料表 / 欄位名稱：

除了直接指定資料表名稱外，您也可以指定用於判斷資料表名稱的 Eloquent 模型：

php

'email' => 'unique:App\Models\User,email_address'

column 選項可用於指定與該欄位對應的資料庫欄位。若未指定 column 選項，則會使用待驗證屬性的名稱。

php

'email' => 'unique:users,email_address'

指定自訂資料庫連線

有時，您可能需要為驗證器 (Validator) 執行的資料庫查詢設定自訂連線。若要達成此目的，可以在資料表名稱前加上連線名稱：

php

'email' => 'unique:connection.users,email_address'

強制 unique 規則忽略特定的 ID：

有時，您可能希望在進行唯一性驗證時忽略特定的 ID。例如，考慮一個包含使用者名稱、電子郵件地址和所在位置的「更新個人資料」畫面。您可能想要驗證電子郵件地址是否唯一。然而，如果使用者只更改了名稱欄位而沒有更改電子郵件欄位，您不希望因為該使用者已經是該電子郵件地址的擁有者而拋出驗證錯誤。

為了指示驗證器忽略該使用者的 ID，我們將使用 Rule 類別來流暢地定義規則。在此範例中，我們還將驗證規則指定為陣列，而非使用 | 字元來分隔規則：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

Validator::make($data, [
    'email' => [
        'required',
        Rule::unique('users')->ignore($user->id),
    ],
]);

⚠️ 警告

您絕不應該將任何使用者控制的請求輸入傳遞給 ignore 方法。相反地，您應該只傳遞系統產生的唯一 ID，例如來自 Eloquent 模型實例的自動遞增 ID 或 UUID。否則，您的應用程式將容易受到 SQL 注入攻擊。

除了將模型的主鍵值傳遞給 ignore 方法外，您也可以傳遞整個模型實例。Laravel 將會自動從模型中提取主鍵：

php

Rule::unique('users')->ignore($user)

如果您的資料表使用 id 以外的主鍵欄位名稱，您可以在呼叫 ignore 方法時指定該欄位的名稱：

php

Rule::unique('users')->ignore($user->id, 'user_id')

預設情況下，unique 規則會檢查與待驗證屬性名稱相符的欄位唯一性。然而，您可以將不同的欄位名稱作為第二個參數傳遞給 unique 方法：

php

Rule::unique('users', 'email_address')->ignore($user->id)

加入額外的 Where 子句：

您可以透過 where 方法自訂查詢，以指定額外的查詢條件。例如，讓我們加入一個查詢條件，將查詢範圍限制在 account_id 欄位值為 1 的紀錄：

php

'email' => Rule::unique('users')->where(fn (Builder $query) => $query->where('account_id', 1))

在唯一性檢查中忽略軟刪除的紀錄：

預設情況下，唯一性規則在判定唯一性時會包含軟刪除的紀錄。若要從唯一性檢查中排除軟刪除的紀錄，您可以呼叫 withoutTrashed 方法：

php

Rule::unique('users')->withoutTrashed();

如果您的模型對軟刪除紀錄使用 deleted_at 以外的欄位名稱，您可以在呼叫 withoutTrashed 方法時提供該欄位名稱：

php

Rule::unique('users')->withoutTrashed('was_deleted_at');

uppercase

待驗證的欄位必須是大寫。

url

待驗證的欄位必須是有效的 URL。

如果您想指定應視為有效的 URL 協定，可以將協定作為驗證規則參數傳入：

php

'url' => 'url:http,https',

'game' => 'url:minecraft,steam',

ulid

待驗證的欄位必須是有效的通用唯一詞典排序識別碼 (ULID)。

uuid

待驗證的欄位必須是有效的 RFC 9562（版本 1、3、4、5、6、7 或 8）通用唯一識別碼 (UUID)。

您也可以驗證給定的 UUID 是否符合特定的版本規範：

php

'uuid' => 'uuid:4'

依條件增加規則

當欄位具有特定值時跳過驗證

有時，如果另一個欄位具有特定值，您可能不希望驗證該欄位。您可以使用 exclude_if 驗證規則來達成此目的。在此範例中，如果 has_appointment 欄位的值為 false，則不會驗證 appointment_date 和 doctor_name 欄位：

php

use Illuminate\Support\Facades\Validator;

$validator = Validator::make($data, [
    'has_appointment' => 'required|boolean',
    'appointment_date' => 'exclude_if:has_appointment,false|required|date',
    'doctor_name' => 'exclude_if:has_appointment,false|required|string',
]);

或者，您可以使用 exclude_unless 規則，除非另一個欄位具有特定值，否則不驗證該欄位：

php

$validator = Validator::make($data, [
    'has_appointment' => 'required|boolean',
    'appointment_date' => 'exclude_unless:has_appointment,true|required|date',
    'doctor_name' => 'exclude_unless:has_appointment,true|required|string',
]);

當欄位存在時才驗證

在某些情況下，您可能希望僅在該欄位存在於要驗證的資料中時，才對該欄位執行驗證檢查。要快速達成此目的，請將 sometimes 規則加入您的規則列表中：

php

$validator = Validator::make($data, [
    'email' => 'sometimes|required|email',
]);

在上述範例中，只有當 email 欄位存在於 $data 陣列中時，才會對其進行驗證。

📌 備註

如果您嘗試驗證一個應該始終存在但可能為空的欄位，請查看關於選填欄位的注意事項。

複雜的條件式驗證

有時您可能希望根據更複雜的條件邏輯來增加驗證規則。例如，您可能希望僅當另一個欄位的值大於 100 時才要求指定欄位。或者，您可能需要兩個欄位僅在另一個欄位存在時才具有特定值。增加這些驗證規則並不困難。首先，使用永不改變的靜態規則建立一個 Validator 實例：

php

use Illuminate\Support\Facades\Validator;

$validator = Validator::make($request->all(), [
    'email' => 'required|email',
    'games' => 'required|integer|min:0',
]);

假設我們的網頁應用程式是為遊戲收藏家設計的。如果一位遊戲收藏家在我們的應用程式註冊，且他們擁有超過 100 款遊戲，我們希望他們解釋為什麼擁有這麼多遊戲。例如，也許他們經營一家遊戲二手店，或者他們只是單純喜歡收集遊戲。要依條件增加此要求，我們可以在 Validator 實例上使用 sometimes 方法。

php

use Illuminate\Support\Fluent;

$validator->sometimes('reason', 'required|max:500', function (Fluent $input) {
    return $input->games >= 100;
});

sometimes 方法的第一個參數是我們要依條件驗證的欄位名稱。第二個參數是我們要增加的規則列表。如果作為第三個參數傳遞的 Closure 回傳 true，則會增加這些規則。此方法讓建構複雜的條件式驗證變得非常簡單。您甚至可以一次為多個欄位增加條件式驗證：

php

$validator->sometimes(['reason', 'cost'], 'required', function (Fluent $input) {
    return $input->games >= 100;
});

📌 備註

傳遞給 Closure 的 $input 參數將是 Illuminate\Support\Fluent 的實例，可用於存取您的輸入資料以及驗證中的檔案。

複雜的條件式陣列驗證

有時您可能想根據同一個巢狀陣列中另一個您不知道其索引的欄位來驗證某個欄位。在這種情況下，您可以讓 Closure 接收第二個參數，該參數將是目前正被驗證的陣列中的個別項目：

php

$input = [
    'channels' => [
        [
            'type' => 'email',
            'address' => '[email protected]',
        ],
        [
            'type' => 'url',
            'address' => 'https://example.com',
        ],
    ],
];

$validator->sometimes('channels.*.address', 'email', function (Fluent $input, Fluent $item) {
    return $item->type === 'email';
});

$validator->sometimes('channels.*.address', 'url', function (Fluent $input, Fluent $item) {
    return $item->type !== 'email';
});

與傳遞給 Closure 的 $input 參數一樣，當屬性資料是陣列時，$item 參數是 Illuminate\Support\Fluent 的實例；否則，它是一個字串。

驗證陣列

正如 array 驗證規則文件中所討論的，array 規則接受一組允許的陣列鍵值清單。如果陣列中存在任何額外的鍵值，驗證將會失敗：

php

use Illuminate\Support\Facades\Validator;

$input = [
    'user' => [
        'name' => 'Taylor Otwell',
        'username' => 'taylorotwell',
        'admin' => true,
    ],
];

Validator::make($input, [
    'user' => 'array:name,username',
]);

通常，您應該始終指定允許出現在陣列中的陣列鍵值。否則，驗證器的 validate 與 validated 方法將會回傳所有已驗證的資料，包含該陣列及其所有的鍵值，即使這些鍵值並未被其他巢狀陣列驗證規則驗證過。

驗證巢狀陣列輸入資料

驗證巢狀陣列形式的表單輸入欄位其實並不難。您可以使用「點」語法 (dot notation) 來驗證陣列中的屬性。例如，若傳入的 HTTP 請求包含 photos[profile] 欄位，您可以像這樣進行驗證：

php

use Illuminate\Support\Facades\Validator;

$validator = Validator::make($request->all(), [
    'photos.profile' => 'required|image',
]);

您也可以驗證陣列中的每個元素。例如，若要驗證給定陣列輸入欄位中的每個 email 是否唯一，您可以執行以下操作：

php

$validator = Validator::make($request->all(), [
    'users.*.email' => 'email|unique:users',
    'users.*.first_name' => 'required_with:users.*.last_name',
]);

同樣地，在語言檔中指定自訂驗證訊息時，您可以使用 * 字元，這使得為陣列欄位使用單一驗證訊息變得非常簡單：

php

'custom' => [
    'users.*.email' => [
        'unique' => 'Each user must have a unique email address',
    ]
],

Accessing Nested Array Data

有時您可能需要在為屬性分配驗證規則時，存取給定巢狀陣列元素的值。您可以使用 Rule::forEach 方法來達成此目的。forEach 方法接受一個 Closure，該 Closure 將針對驗證中陣列屬性的每次迭代進行調用，並接收該屬性的值與明確且完整展開的屬性名稱。該 Closure 應回傳要分配給陣列元素的規則陣列：

php

use App\Rules\HasPermission;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

$validator = Validator::make($request->all(), [
    'companies.*.id' => Rule::forEach(function (string|null $value, string $attribute) {
        return [
            Rule::exists(Company::class, 'id'),
            new HasPermission('manage-company', $value),
        ];
    }),
]);

錯誤訊息的索引與位置

驗證陣列時，您可能希望在應用程式顯示的錯誤訊息中引用驗證失敗之特定項目的索引或位置。為了達成此目的，您可以在自訂驗證訊息中使用 :index (從 0 開始)、:position (從 1 開始) 或 :ordinal-position (從 1st 開始) 佔位符：

php

use Illuminate\Support\Facades\Validator;

$input = [
    'photos' => [
        [
            'name' => 'BeachVacation.jpg',
            'description' => 'A photo of my beach vacation!',
        ],
        [
            'name' => 'GrandCanyon.jpg',
            'description' => '',
        ],
    ],
];

Validator::validate($input, [
    'photos.*.description' => 'required',
], [
    'photos.*.description.required' => 'Please describe photo #:position.',
]);

根據上述範例，驗證將失敗，並向使用者顯示以下錯誤："Please describe photo #2."

如有必要，您可以透過 second-index、second-position、third-index、third-position 等引用更深層的巢狀索引與位置。

php

'photos.*.attributes.*.string' => 'Invalid attribute for photo #:second-position.',

驗證檔案

Laravel 提供各種可用於驗證上傳檔案的驗證規則，例如 mimes、image、min 與 max。雖然您可以在驗證檔案時自由地個別指定這些規則，但 Laravel 也提供了一個流暢的檔案驗證規則建構器，您可能會覺得這很方便：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\File;

Validator::validate($input, [
    'attachment' => [
        'required',
        File::types(['mp3', 'wav'])
            ->min(1024)
            ->max(12 * 1024),
    ],
]);

Validating File Types

即使您在調用 types 方法時只需要指定擴充功能，此方法實際上會透過讀取檔案內容並猜測其 MIME 類型來驗證檔案的 MIME 類型。完整的 MIME 類型及其對應擴充功能的清單可以在以下位置找到：

https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types

Validating File Sizes

為了方便起見，最小與最大檔案大小可以指定為帶有指示檔案大小單位後綴的字串。支援 kb、mb、gb 與 tb 後綴：

php

File::types(['mp3', 'wav'])
    ->min('1kb')
    ->max('10mb');

Validating Image Files

如果您的應用程式接受使用者上傳的圖片，您可以使用 File 規則的 image 建構方法，以確保被驗證的檔案是圖片 (jpg、jpeg、png、bmp、gif 或 webp)。

此外，dimensions 規則可用於限制圖片的尺寸：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;

Validator::validate($input, [
    'photo' => [
        'required',
        File::image()
            ->min(1024)
            ->max(12 * 1024)
            ->dimensions(Rule::dimensions()->maxWidth(1000)->maxHeight(500)),
    ],
]);

📌 備註

關於驗證圖片尺寸的更多資訊可以在 dimension 規則文件中找到。

⚠️ 警告

預設情況下，由於可能存在 XSS 漏洞，image 規則不允許 SVG 檔案。如果您需要允許 SVG 檔案，可以將 allowSvg: true 傳遞給 image 規則：File::image(allowSvg: true)。

Validating Image Dimensions

您也可以驗證圖片的尺寸。例如，若要驗證上傳的圖片寬度至少為 1000 像素且高度為 500 像素，您可以使用 dimensions 規則：

php

use Illuminate\Validation\Rule;
use Illuminate\Validation\Rules\File;

File::image()->dimensions(
    Rule::dimensions()
        ->maxWidth(1000)
        ->maxHeight(500)
)

📌 備註

關於驗證圖片尺寸的更多資訊可以在 dimension 規則文件中找到。

驗證密碼

為了確保密碼具有足夠的複雜度，您可以使用 Laravel 的 Password 規則物件：

php

use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rules\Password;

$validator = Validator::make($request->all(), [
    'password' => ['required', 'confirmed', Password::min(8)],
]);

Password 規則物件讓您可以輕鬆地自訂應用程式的密碼複雜度需求，例如指定密碼需要至少一個字母、數字、符號或是大小寫混合的字元：

php

// Require at least 8 characters...
Password::min(8)

// Require at least one letter...
Password::min(8)->letters()

// Require at least one uppercase and one lowercase letter...
Password::min(8)->mixedCase()

// Require at least one number...
Password::min(8)->numbers()

// Require at least one symbol...
Password::min(8)->symbols()

此外，您可以使用 uncompromised 方法來確保密碼未曾在公開的密碼外洩事件中出現：

php

Password::min(8)->uncompromised()

在內部，Password 規則物件使用 k-Anonymity 模型，在不犧牲使用者隱私或安全性的情況下，透過 haveibeenpwned.com 服務來判斷密碼是否已經外洩。

預設情況下，如果密碼在資料外洩中出現過至少一次，就會被視為已遭外洩。您可以使用 uncompromised 方法的第一個參數來自訂這個門檻值：

php

// Ensure the password appears less than 3 times in the same data leak...
Password::min(8)->uncompromised(3);

當然，您可以鏈結上述範例中的所有方法：

php

Password::min(8)
    ->letters()
    ->mixedCase()
    ->numbers()
    ->symbols()
    ->uncompromised()

定義預設密碼規則

您可能會發現，在應用程式的單一位置指定密碼的預設驗證規則會非常方便。您可以使用 Password::defaults 方法輕鬆達成此目的，該方法接受一個 Closure。傳遞給 defaults 方法的 Closure 應該回傳 Password 規則的預設組態。通常，應該在應用程式其中一個服務提供者的 boot 方法中呼叫 defaults 規則：

php

use Illuminate\Validation\Rules\Password;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Password::defaults(function () {
        $rule = Password::min(8);

        return $this->app->isProduction()
            ? $rule->mixedCase()->uncompromised()
            : $rule;
    });
}

接著，當您想將預設規則套用到正在驗證的特定密碼時，您可以呼叫不帶任何參數的 defaults 方法：

php

'password' => ['required', Password::defaults()],

有時，您可能想在預設密碼驗證規則中附加額外的驗證規則。您可以使用 rules 方法來達成此目的：

php

use App\Rules\ZxcvbnRule;

Password::defaults(function () {
    $rule = Password::min(8)->rules([new ZxcvbnRule]);

    // ...
});

自訂驗證規則

使用規則物件

Laravel 提供多種實用的驗證規則；不過，你可能想定義自己的規則。註冊自訂驗證規則的方法之一是使用規則物件。要產生新的規則物件，你可以使用 make:rule Artisan 指令。讓我們使用此指令來產生一個驗證字串是否為大寫的規則。Laravel 會將新規則放置在 app/Rules 目錄中。如果此目錄不存在，當你執行 Artisan 指令來建立規則時，Laravel 將會自動建立它：

shell

php artisan make:rule Uppercase

規則建立後，我們就可以定義它的行為。一個規則物件包含一個方法：validate。此方法接收屬性名稱、其值，以及一個在驗證失敗時應呼叫的 callback，並傳入驗證錯誤訊息：

php

<?php

namespace App\Rules;

use Closure;
use Illuminate\Contracts\Validation\ValidationRule;

class Uppercase implements ValidationRule
{
    /**
     * Run the validation rule.
     */
    public function validate(string $attribute, mixed $value, Closure $fail): void
    {
        if (strtoupper($value) !== $value) {
            $fail('The :attribute must be uppercase.');
        }
    }
}

定義好規則後，你可以將規則物件的執行個體連同其他驗證規則一起傳給驗證器，藉此附加該規則：

php

use App\Rules\Uppercase;

$request->validate([
    'name' => ['required', 'string', new Uppercase],
]);

翻譯驗證訊息

除了提供文字錯誤訊息給 $fail closure 之外，你也可以提供一個翻譯字串鍵並指示 Laravel 翻譯該錯誤訊息：

php

if (strtoupper($value) !== $value) {
    $fail('validation.uppercase')->translate();
}

如有需要，你可以提供佔位符替換內容以及偏好的語言，分別作為 translate 方法的第一個和第二個參數：

php

$fail('validation.location')->translate([
    'value' => $this->value,
], 'fr');

存取額外資料

如果你的自訂驗證規則類別需要存取所有正在進行驗證的其他資料，你的規則類別可以實作 Illuminate\Contracts\Validation\DataAwareRule 介面。這個介面要求你的類別定義一個 setData 方法。Laravel 會在進行驗證前，自動呼叫此方法並傳入所有正在驗證中的資料：

php

<?php

namespace App\Rules;

use Illuminate\Contracts\Validation\DataAwareRule;
use Illuminate\Contracts\Validation\ValidationRule;

class Uppercase implements DataAwareRule, ValidationRule
{
    /**
     * All of the data under validation.
     *
     * @var array<string, mixed>
     */
    protected $data = [];

    // ...

    /**
     * Set the data under validation.
     *
     * @param  array<string, mixed>  $data
     */
    public function setData(array $data): static
    {
        $this->data = $data;

        return $this;
    }
}

或者，如果你的驗證規則需要存取執行驗證的驗證器實例，你可以實作 ValidatorAwareRule 介面：

php

<?php

namespace App\Rules;

use Illuminate\Contracts\Validation\ValidationRule;
use Illuminate\Contracts\Validation\ValidatorAwareRule;
use Illuminate\Validation\Validator;

class Uppercase implements ValidationRule, ValidatorAwareRule
{
    /**
     * The validator instance.
     *
     * @var \Illuminate\Validation\Validator
     */
    protected $validator;

    // ...

    /**
     * Set the current validator.
     */
    public function setValidator(Validator $validator): static
    {
        $this->validator = $validator;

        return $this;
    }
}

使用 Closures

如果你在整個應用程式中只需要一次自訂規則的功能，可以使用 closure 代替規則物件。該 closure 接收屬性名稱、屬性值以及一個在驗證失敗時應呼叫的 $fail callback：

php

use Illuminate\Support\Facades\Validator;
use Closure;

$validator = Validator::make($request->all(), [
    'title' => [
        'required',
        'max:255',
        function (string $attribute, mixed $value, Closure $fail) {
            if ($value === 'foo') {
                $fail("The {$attribute} is invalid.");
            }
        },
    ],
]);

隱含規則

預設情況下，當被驗證的屬性不存在或包含空字串時，一般的驗證規則（包括自訂規則）都不會執行。例如，unique 規則不會針對空字串執行：

php

use Illuminate\Support\Facades\Validator;

$rules = ['name' => 'unique:users,name'];

$input = ['name' => ''];

Validator::make($input, $rules)->passes(); // true

為了讓自訂規則在屬性為空時也能執行，該規則必須暗示該屬性是必要的。要快速產生一個新的隱含規則物件，你可以使用帶有 --implicit 選項的 make:rule Artisan 指令：

shell

php artisan make:rule Uppercase --implicit

⚠️ 警告

「隱含」規則僅是「暗示」該屬性是必要的。它是否真的使缺失或空的屬性驗證不通過，完全取決於你。

表單驗證 ​

簡介 ​

驗證快速入門 ​

定義路由 ​

建立控制器 ​

撰寫驗證邏輯 ​

在首次驗證失敗時停止 ​

關於巢狀屬性的注意事項 ​

顯示驗證錯誤 ​

自訂錯誤訊息 ​

XHR 請求與驗證 ​

@error 指令 ​

重新填入表單 ​

關於選填欄位的注意事項 ​

驗證錯誤回應格式 ​

Form Request 驗證 ​

建立 Form Request ​

進行額外的驗證 ​

在第一個驗證失敗時停止 ​

自訂重新導向位置 ​

授權 Form Request ​

自訂錯誤訊息 ​

自訂驗證屬性名稱 ​

準備驗證所需的輸入資料 ​

手動建立驗證器 ​

在第一個驗證失敗時停止 ​

自動重新導向 ​

命名的錯誤包 (Error Bags) ​

自訂錯誤訊息 ​

為指定屬性指定自訂訊息 ​

指定自訂屬性名稱 ​

進行額外的驗證 ​

使用驗證過的輸入資料 ​

使用錯誤訊息 ​

取得欄位的第一條錯誤訊息 ​

取得欄位的所有錯誤訊息 ​

取得所有欄位的所有錯誤訊息 ​

判斷欄位是否存在訊息 ​

在語言檔中指定自訂訊息 ​

特定屬性的自訂訊息 ​

在語言檔中指定屬性名稱 ​

在語言檔中指定值 ​

可用的驗證規則 ​

布林值 ​

字串 ​

數字 ​

陣列 ​

日期 ​

檔案 ​

資料庫 ​

公用程式 ​

accepted ​

accepted_if:anotherfield,value,... ​

active_url ​

after:date ​

after_or_equal:date ​

anyOf ​

alpha ​

alpha_dash ​

alpha_num ​

array ​

ascii ​

bail ​

before:date ​

before_or_equal:date ​

between:min,max ​

boolean ​

confirmed ​

contains:foo,bar,... ​

doesnt_contain:foo,bar,... ​

current_password ​

date ​

date_equals:date ​

date_format:format,... ​

decimal:min,max ​

declined ​

declined_if:anotherfield,value,... ​

different:field ​

digits:value ​

digits_between:min,max ​

表單驗證

簡介

驗證快速入門

定義路由

建立控制器

撰寫驗證邏輯

在首次驗證失敗時停止

關於巢狀屬性的注意事項

顯示驗證錯誤

自訂錯誤訊息

XHR 請求與驗證

`@error` 指令

重新填入表單

關於選填欄位的注意事項

驗證錯誤回應格式

Form Request 驗證

建立 Form Request

進行額外的驗證

在第一個驗證失敗時停止

自訂重新導向位置

授權 Form Request

自訂錯誤訊息

自訂驗證屬性名稱

準備驗證所需的輸入資料

手動建立驗證器

在第一個驗證失敗時停止

自動重新導向

命名的錯誤包 (Error Bags)

自訂錯誤訊息

為指定屬性指定自訂訊息

指定自訂屬性名稱

進行額外的驗證

使用驗證過的輸入資料

使用錯誤訊息

取得欄位的第一條錯誤訊息

取得欄位的所有錯誤訊息

取得所有欄位的所有錯誤訊息

判斷欄位是否存在訊息

在語言檔中指定自訂訊息

特定屬性的自訂訊息

在語言檔中指定屬性名稱

在語言檔中指定值

可用的驗證規則

布林值

字串

數字

陣列

日期

檔案

資料庫

公用程式

accepted

accepted_if:anotherfield,value,...

active_url

after:date

after_or_equal:date

anyOf

alpha

alpha_dash

alpha_num

array

ascii

bail

before:date

before_or_equal:date

between:min,max

boolean

confirmed

contains:foo,bar,...

doesnt_contain:foo,bar,...

current_password

date

date_equals:date

date_format:format,...

decimal:min,max

declined

declined_if:anotherfield,value,...

different:field

digits:value

digits_between:min,max