驗證

簡介
驗證快速入門
表單請求驗證
手動建立驗證器
處理已驗證的輸入
處理錯誤訊息
可用的驗證規則
有條件地新增規則
驗證陣列
- 驗證巢狀陣列輸入
- 錯誤訊息索引與位置
驗證檔案
驗證密碼
自訂驗證規則

簡介

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 方法來驗證請求，並將任何錯誤訊息儲存在命名錯誤包中：

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 請求包含「巢狀」欄位資料，您可以使用「點」語法在驗證規則中指定這些欄位：

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 將會自動把使用者導回他們上一個位置。此外，所有驗證錯誤和請求輸入都將自動快閃至 Session。

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

因此，在我們的範例中，當驗證失敗時，使用者將會被導向回我們控制器的 create 方法，這讓您可以在視圖中顯示錯誤訊息：

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 目錄，您可以指示 Laravel 使用 lang:publish Artisan 命令來建立它。

在 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 指令中，您可以 echo $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 指令：

blade

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

重新填寫表單

當 Laravel 因驗證錯誤而產生轉導回應時，框架將會自動快閃所有請求的輸入至 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 回應格式範例。請注意，巢狀錯誤鍵會被扁平化為「點」表示法格式：

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)」。表單請求是自訂的請求類別，它們封裝了自己的驗證與授權邏輯。若要建立表單請求類別，您可以使用 make:request Artisan CLI 指令：

shell

php artisan make:request StorePostRequest

產生的表單請求類別將會被放置在 app/Http/Requests 目錄中。如果此目錄不存在，當您執行 make:request 指令時，它將會被建立。每個由 Laravel 產生的表單請求都包含兩個方法：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 方法的簽名中型別提示您所需的任何依賴項。它們將透過 Laravel 服務容器自動解析。

那麼，驗證規則是如何被評估的呢？您所需要做的，只是在控制器方法中對請求進行型別提示 (type-hint)。傳入的表單請求會在控制器方法被呼叫之前進行驗證，這表示您不需要在控制器中混雜任何驗證邏輯：

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');
}

如果驗證失敗，將會產生一個轉導回應 (redirect response)，將使用者轉導回其先前的位置。錯誤也會被快閃 (flash) 到 Session 中，以便於顯示。如果該請求是一個 XHR 請求，則將會回傳一個 HTTP 狀態碼為 422 的回應給使用者，其中包含驗證錯誤的 JSON 呈現。

📌 備註

需要為您的 Inertia 驅動的 Laravel 前端新增即時表單請求驗證嗎？請參考 Laravel Precognition。

執行額外驗證

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

after 方法應回傳一個可呼叫 (callable) 物件或閉包 (closure) 陣列，這些物件或閉包會在驗證完成後被呼叫。這些給定的可呼叫物件將會收到一個 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;

自訂轉導位置

當表單請求驗證失敗時，將會產生一個轉導回應，將使用者轉導回其先前的位置。不過，您可以自由地自訂此行為。若要這麼做，請在您的表單請求中定義一個 $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';

授權表單請求

表單請求類別也包含一個 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);
}

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

php

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

因此，如果您的應用程式利用了路由模型綁定，您的程式碼可以透過將已解析的模型作為請求的屬性來存取，從而使其更加簡潔：

php

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

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

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

php

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

📌 備註

您可以在 authorize 方法的簽名中型別提示您所需的任何依賴項。它們將透過 Laravel 服務容器自動解析。

自訂錯誤訊息

您可以透過覆寫 (overriding) 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 佔位符替換為自訂的屬性名稱，您可以透過覆寫 (overriding) attributes 方法來指定自訂名稱。此方法應回傳一個包含屬性 / 名稱配對的陣列：

php

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

準備要驗證的輸入

如果您需要在套用驗證規則之前，準備或淨化 (sanitize) 請求 (request) 中的任何資料，可以使用 prepareForValidation 方法：

php

use Illuminate\Support\Str;

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

同樣地，如果您需要在驗證完成後正規化 (normalize) 任何請求資料，可以使用 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 方法將錯誤訊息儲存在命名錯誤包中：

php

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

命名錯誤包

如果您在單一頁面上有多個表單，您可能希望為包含驗證錯誤的 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',
];

為給定屬性指定自訂訊息

有時候您可能希望只為特定屬性指定自訂錯誤訊息。您可以使用「點符號表示法」來做到這一點。先指定屬性名稱，然後是規則：

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 方法接受一個閉包或一個可呼叫的陣列，這些閉包或可呼叫將在驗證完成後被呼叫。給定的可呼叫將接收一個 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 方法也接受一個可呼叫的陣列，如果您的「驗證後」邏輯封裝在可呼叫類別中，這尤其方便。這些類別將透過其 __invoke 方法接收 Illuminate\Validation\Validator 實例：

php

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

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

處理已驗證的輸入

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

php

$validated = $request->validated();

$validated = $validator->validated();

或者，您可以呼叫表單請求或驗證器實例上的 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 目錄，您可以指示 Laravel 使用 lang:publish Artisan 命令來建立它。

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

此外，您可以將此檔案複製到另一個語言目錄，以翻譯應用程式語言的訊息。若要深入了解 Laravel 的本地化，請查閱完整的本地化說明文件。

⚠️ 警告

預設情況下，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

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

after:date

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

php

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

除了傳遞日期字串給 strtotime 評估外，您還可以指定另一個欄位來與日期進行比較：

php

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

為了方便起見，可以利用 Fluent 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 規則。

為了方便起見，可以利用 Fluent 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

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

若要將此驗證規則限制為 ASCII 範圍 (a-z、A-Z 和 0-9) 中的字元，您可以為驗證規則提供 ascii 選項：

php

'username' => 'alpha_dash:ascii',

alpha_num

驗證中的欄位必須完全是 Unicode 英數字元，包含於 \p{L}、\p{M} 和 \p{N} 中。

若要將此驗證規則限制為 ASCII 範圍 (a-z、A-Z 和 0-9) 中的字元，您可以為驗證規則提供 ascii 選項：

php

'username' => 'alpha_num:ascii',

array

驗證中的欄位必須是 PHP array。

當為 array 規則提供額外的值時，輸入陣列中的每個鍵都必須存在於提供給規則的值列表中。在以下範例中，輸入陣列中的 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 位元的 ASCII 字元。

bail

在首次驗證失敗後，停止執行該欄位的驗證規則。

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

php

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

before:日期

驗證中的欄位必須是早於指定日期的值。日期將傳遞給 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:日期

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

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

php

use Illuminate\Validation\Rule;

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

between:最小值,最大值

驗證中的欄位大小必須介於給定的 最小值 和 最大值 之間 (包含)。字串、數字、陣列和檔案的評估方式與 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:值1,值2,...

驗證中的欄位必須是一個包含所有指定參數值的陣列。由於此規則通常需要您 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:值1,值2,...

驗證中的欄位必須是一個不包含任何指定參數值的陣列。由於此規則通常需要您 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:日期

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

date_format:格式,...

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

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

php

use Illuminate\Validation\Rule;

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

decimal:最小值,最大值

驗證中的欄位必須是數字，並且必須包含指定的小數點位數：

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:另一個欄位,值,...

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

different:欄位

驗證中的欄位必須與欄位具有不同值。

digits:值

驗證中的整數長度必須精確為值。

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

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

php

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

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

rfc: RFCValidation - 根據支援的 RFC 驗證 Email 位址。
strict: NoRFCWarningsValidation - 根據支援的 RFC 驗證 Email，當發現警告時失敗 (例如，尾隨句點和多個連續句點)。
dns: DNSCheckValidation - 確保 Email 位址的網域具有有效的 MX 記錄。
spoof: SpoofCheckValidation - 確保 Email 位址不包含同形異義字或欺騙性 Unicode 字元。
filter: FilterEmailValidation - 確保 Email 位址根據 PHP 的 filter_var 函數有效。
filter_unicode: FilterEmailValidation::unicode() - 確保 Email 位址根據 PHP 的 filter_var 函數有效，允許某些 Unicode 字元。

為了方便，Email 驗證規則可以使用流暢的規則建構器來建立：

php

use Illuminate\Validation\Rule;

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

⚠️ 警告

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

ends_with:foo,bar,...

驗證中的欄位必須以給定值之一結尾。

enum

Enum 規則是一個基於類別的規則，用於驗證驗證中的欄位是否包含有效的 enum 值。Enum 規則接受 enum 的名稱作為其唯一的建構子引數。在驗證原始值時，應向 Enum 規則提供備份的 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 方法。此方法接受一個布林值或一個閉包。當給定閉包時，閉包應返回 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

正在驗證的欄位必須包含有效十六進位格式的顏色值。

image

正在驗證的檔案必須是圖片（jpg、jpeg、png、bmp、gif 或 webp）。

⚠️ 警告

依預設，image 規則不允許 SVG 檔案，因為可能存在 XSS 漏洞。如果您需要允許 SVG 檔案，您可以為 image 規則提供 allow_svg 指令（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'

⚠️ 警告

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

ip

正在驗證的欄位必須是 IP 位址。

ipv4

正在驗證的欄位必須是 IPv4 位址。

ipv6

正在驗證的欄位必須是 IPv6 位址。

json

正在驗證的欄位必須是有效的 JSON 字串。

lt:field

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

lte:field

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

lowercase

正在驗證的欄位必須為小寫。

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'

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

mimes:foo,bar,...

待驗證欄位必須具有與列出的副檔名相對應的 MIME 類型：

php

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

儘管您只需要指定副檔名，但此規則實際上是透過讀取檔案內容並猜測其 MIME 類型來驗證檔案的 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

待驗證欄位必須是數值型。

您可以使用 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 方法。此方法接受布林值或閉包。給予閉包時，閉包應回傳 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 方法。此方法接受一個布林值或一個閉包。當傳入閉包時，該閉包應回傳 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，否則待驗證欄位必須存在且不能為空。這也表示 anotherfield 必須存在於請求資料中，除非 value 為 null。如果 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,...

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

same:field

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

size:value

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

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：

有時候，您可能希望在 unique 驗證期間忽略給定的 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))

在 unique 檢查中忽略軟刪除的紀錄：

預設情況下，unique 規則在判斷唯一性時會包含軟刪除的紀錄。要將軟刪除的紀錄從唯一性檢查中排除，您可以呼叫 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

被驗證的欄位必須為有效的 Universally Unique Lexicographically Sortable Identifier (ULID)。

uuid

被驗證的欄位必須為有效的 RFC 9562 (版本 1, 3, 4, 5, 6, 7 或 8) Universally Unique Identifier (UUID)。

您也可以透過版本來驗證給定的 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',
]);

讓我們假設我們的 Web 應用程式是為遊戲收藏家設計的。如果遊戲收藏家在我們的應用程式註冊，並且他們擁有超過 100 款遊戲，我們希望他們解釋為何擁有如此多的遊戲。例如，他們可能是經營遊戲轉售商店，或者只是享受收藏遊戲的樂趣。為了有條件地新增此要求，我們可以在 Validator 實例上使用 sometimes 方法。

php

use Illuminate\Support\Fluent;

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

傳遞給 sometimes 方法的第一個引數是我們有條件地驗證的欄位名稱。第二個引數是我們想要新增的規則清單。如果作為第三個引數傳遞的閉包回傳 true，則這些規則將被新增。這個方法讓建構複雜的條件式驗證變得輕而易舉。您甚至可以一次為多個欄位新增條件式驗證：

php

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

📌 備註

傳遞給閉包的 $input 參數將是 Illuminate\Support\Fluent 的實例，可用於存取您正在驗證的輸入和檔案。

複雜的條件式陣列驗證

有時您可能希望根據同一個巢狀陣列中另一個您不知道索引的欄位來驗證一個欄位。在這些情況下，您可以讓您的閉包接收第二個引數，該引數將是正在驗證的陣列中的當前個別項目：

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';
});

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

驗證陣列

如陣列驗證規則文件中所述，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',
    ]
],

存取巢狀陣列資料

有時您可能需要在為屬性指派驗證規則時，存取給定巢狀陣列元素的值。您可以使用 Rule::forEach 方法來實現。forEach 方法接受一個閉包，該閉包將在驗證陣列屬性的每次迭代時被調用，並接收該屬性值和明確、完全展開的屬性名稱。此閉包應返回一個規則陣列，以指派給該陣列元素：

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.',
]);

根據上述範例，驗證將會失敗，並向使用者顯示錯誤：「請描述照片 #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),
    ],
]);

驗證檔案類型

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

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

驗證檔案大小

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

php

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

驗證圖片檔案

如果您的應用程式接受使用者上傳的圖片，您可以使用 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 規則文件。

⚠️ 警告

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

驗證圖片尺寸

您也可以驗證圖片的尺寸。例如，若要驗證上傳的圖片寬度至少為 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-匿名性模型來判斷密碼是否透過 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 方法輕鬆實現此目的，該方法接受一個閉包。傳遞給 defaults 方法的閉包應返回 Password 規則的預設配置。通常，defaults 規則應在應用程式其中一個服務提供者的 boot 方法中呼叫：

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 目錄中。如果此目錄不存在，Laravel 會在您執行 Artisan 指令建立規則時自動建立它：

shell

php artisan make:rule Uppercase

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

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 閉包提供字面上的錯誤訊息外，您也可以提供一個翻譯字串鍵，並指示 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;
    }
}

使用閉包

如果您的應用程式只需要一次自訂規則的功能，您可以使用閉包而不是規則物件。閉包會接收屬性名稱、屬性值，以及一個在驗證失敗時應呼叫的 $fail 回呼：

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

若要讓自訂規則在屬性為空時也能執行，該規則必須隱含著該屬性是必填的。若要快速生成新的隱式規則物件，您可以使用 make:rule Artisan 指令，並帶上 --implicit 選項：

shell

php artisan make:rule Uppercase --implicit

⚠️ 警告

一個「隱式」規則僅表示該屬性是必填的。它是否真的會使缺少或為空的屬性無效，則取決於您。

驗證 ​

簡介 ​

驗證快速入門 ​

定義路由 ​

建立控制器 ​

撰寫驗證邏輯 ​

在首次驗證失敗時停止 ​

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

顯示驗證錯誤 ​

自訂錯誤訊息 ​

XHR 請求與驗證 ​

@error 指令 ​

重新填寫表單 ​

選填欄位的注意事項 ​

驗證錯誤回應格式 ​

表單請求驗證 ​

建立表單請求 ​

執行額外驗證 ​

首次驗證失敗時停止 ​

自訂轉導位置 ​

授權表單請求 ​

自訂錯誤訊息 ​

自訂驗證屬性 ​

準備要驗證的輸入 ​

手動建立驗證器 ​

停止第一次驗證失敗 ​

自動轉導 ​

命名錯誤包 ​

自訂錯誤訊息 ​

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

指定自訂屬性值 ​

執行額外驗證 ​

處理已驗證的輸入 ​

處理錯誤訊息 ​

擷取欄位的第一個錯誤訊息 ​

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

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

判斷欄位是否存在訊息 ​

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

特定屬性的自訂訊息 ​

在語言檔中指定屬性 ​

在語言檔中指定值 ​

可用的驗證規則 ​

布林值 ​

字串 ​

數值 ​

陣列 ​

日期 ​

檔案 ​

資料庫 ​

公用程式 ​

accepted ​

accepted_if:anotherfield,value,... ​

active_url ​

after:date ​

after_or_equal:date ​

anyOf ​

alpha ​

alpha_dash ​

alpha_num ​

array ​

ascii ​

bail ​

before:日期 ​

before_or_equal:日期 ​

between:最小值,最大值 ​

boolean ​

confirmed ​

contains:值1,值2,... ​

doesnt_contain:值1,值2,... ​

current_password ​

date ​

date_equals:日期 ​

date_format:格式,... ​

decimal:最小值,最大值 ​

declined ​

declined_if:另一個欄位,值,... ​

different:欄位 ​

digits:值 ​

digits_between:min,max ​

驗證

簡介

驗證快速入門

定義路由

建立控制器

撰寫驗證邏輯

在首次驗證失敗時停止

關於巢狀屬性的注意事項

顯示驗證錯誤

自訂錯誤訊息

XHR 請求與驗證

`@error` 指令

重新填寫表單

選填欄位的注意事項

驗證錯誤回應格式

表單請求驗證

建立表單請求

執行額外驗證

首次驗證失敗時停止

自訂轉導位置

授權表單請求

自訂錯誤訊息

自訂驗證屬性

準備要驗證的輸入

手動建立驗證器

停止第一次驗證失敗

自動轉導

命名錯誤包

自訂錯誤訊息

為給定屬性指定自訂訊息

指定自訂屬性值

執行額外驗證

處理已驗證的輸入

處理錯誤訊息

擷取欄位的第一個錯誤訊息

擷取欄位的所有錯誤訊息

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

判斷欄位是否存在訊息

在語言檔中指定自訂訊息

特定屬性的自訂訊息

在語言檔中指定屬性

在語言檔中指定值

可用的驗證規則

布林值

字串

數值

陣列

日期

檔案

資料庫

公用程式

accepted

accepted_if:anotherfield,value,...

active_url

after:date

after_or_equal:date

anyOf

alpha

alpha_dash

alpha_num

array

ascii

bail

before:日期

before_or_equal:日期

between:最小值,最大值

boolean

confirmed

contains:值1,值2,...

doesnt_contain:值1,值2,...

current_password

date

date_equals:日期

date_format:格式,...

decimal:最小值,最大值

declined

declined_if:另一個欄位,值,...

different:欄位

digits:值

digits_between:min,max