Validation

• Introduction
• Validation Quickstart
  • Defining The Routes
  • Creating The Controller
  • Writing The Validation Logic
  • Displaying The Validation Errors
  • Repopulating Forms
  • A Note On Optional Fields
• Form Request Validation
  • Creating Form Requests
  • Authorizing Form Requests
  • Customizing The Error Messages
  • Preparing Input For Validation
• Manually Creating Validators
  • Automatic Redirection
  • Named Error Bags
  • Customizing The Error Messages
  • After Validation Hook
• Working With Validated Input
• Working With Error Messages
  • Specifying Custom Messages In Language Files
  • Specifying Attributes In Language Files
  • Specifying Values In Language Files
• Available Validation Rules
• Conditionally Adding Rules
• Validating Arrays
  • Excluding Unvalidated Array Keys
  • Validating Nested Array Input
• Validating Passwords
• Custom Validation Rules
  • Using Rule Objects
  • Using Closures
  • Implicit Rules

Introduction

Laravel provides several different approaches to validate your application's incoming data. It is most common to use the validate method available on all incoming HTTP requests. However, we will discuss other approaches to validation as well.

Laravel includes a wide variety of convenient validation rules that you may apply to data, even providing the ability to validate if values are unique in a given database table. We'll cover each of these validation rules in detail so that you are familiar with all of Laravel's validation features.

Validation Quickstart

To learn about Laravel's powerful validation features, let's look at a complete example of validating a form and displaying the error messages back to the user. By reading this high-level overview, you'll be able to gain a good general understanding of how to validate incoming request data using Laravel:

Defining The Routes

First, let's assume we have the following routes defined in our routes/web.php file:

1use App\Http\Controllers\PostController;
2 
3Route::get('/post/create', [PostController::class, 'create']);
4Route::post('/post', [PostController::class, 'store']);
1use App\Http\Controllers\PostController;
2 
3Route::get('/post/create', [PostController::class, 'create']);
4Route::post('/post', [PostController::class, 'store']);

The GET route will display a form for the user to create a new blog post, while the POST route will store the new blog post in the database.

Creating The Controller

Next, let's take a look at a simple controller that handles incoming requests to these routes. We'll leave the store method empty for now:

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Http\Request;
 7 
 8class PostController extends Controller
 9{
10    /**
11     * Show the form to create a new blog post.
12     *
13     * @return \Illuminate\View\View
14     */
15    public function create()
16    {
17        return view('post.create');
18    }
19 
20    /**
21     * Store a new blog post.
22     *
23     * @param  \Illuminate\Http\Request  $request
24     * @return \Illuminate\Http\Response
25     */
26    public function store(Request $request)
27    {
28        // Validate and store the blog post...
29    }
30}
 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Http\Request;
 7 
 8class PostController extends Controller
 9{
10    /**
11     * Show the form to create a new blog post.
12     *
13     * @return \Illuminate\View\View
14     */
15    public function create()
16    {
17        return view('post.create');
18    }
19 
20    /**
21     * Store a new blog post.
22     *
23     * @param  \Illuminate\Http\Request  $request
24     * @return \Illuminate\Http\Response
25     */
26    public function store(Request $request)
27    {
28        // Validate and store the blog post...
29    }
30}

Writing The Validation Logic

Now we are ready to fill in our store method with the logic to validate the new blog post. To do this, we will use the validate method provided by the Illuminate\Http\Request object. If the validation rules pass, your code will keep executing normally; however, if validation fails, an Illuminate\Validation\ValidationException exception will be thrown and the proper error response will automatically be sent back to the user.

If validation fails during a traditional HTTP request, a redirect response to the previous URL will be generated. If the incoming request is an XHR request, a JSON response containing the validation error messages will be returned.

To get a better understanding of the validate method, let's jump back into the store method:

 1/**
 2 * Store a new blog post.
 3 *
 4 * @param  \Illuminate\Http\Request  $request
 5 * @return \Illuminate\Http\Response
 6 */
 7public function store(Request $request)
 8{
 9    $validated = $request->validate([
10        'title' => 'required|unique:posts|max:255',
11        'body' => 'required',
12    ]);
13 
14    // The blog post is valid...
15}
 1/**
 2 * Store a new blog post.
 3 *
 4 * @param  \Illuminate\Http\Request  $request
 5 * @return \Illuminate\Http\Response
 6 */
 7public function store(Request $request)
 8{
 9    $validated = $request->validate([
10        'title' => 'required|unique:posts|max:255',
11        'body' => 'required',
12    ]);
13 
14    // The blog post is valid...
15}

As you can see, the validation rules are passed into the validate method. Don't worry - all available validation rules are documented. Again, if the validation fails, the proper response will automatically be generated. If the validation passes, our controller will continue executing normally.

Alternatively, validation rules may be specified as arrays of rules instead of a single | delimited string:

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

In addition, you may use the validateWithBag method to validate a request and store any error messages within a named error bag:

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

Stopping On First Validation Failure

Sometimes you may wish to stop running validation rules on an attribute after the first validation failure. To do so, assign the bail rule to the attribute:

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

In this example, if the unique rule on the title attribute fails, the max rule will not be checked. Rules will be validated in the order they are assigned.

A Note On Nested Attributes

If the incoming HTTP request contains "nested" field data, you may specify these fields in your validation rules using "dot" syntax:

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

On the other hand, if your field name contains a literal period, you can explicitly prevent this from being interpreted as "dot" syntax by escaping the period with a backslash:

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

Displaying The Validation Errors

So, what if the incoming request fields do not pass the given validation rules? As mentioned previously, Laravel will automatically redirect the user back to their previous location. In addition, all of the validation errors and request input will automatically be flashed to the session.

An $errors variable is shared with all of your application's views by the Illuminate\View\Middleware\ShareErrorsFromSession middleware, which is provided by the web middleware group. When this middleware is applied an $errors variable will always be available in your views, allowing you to conveniently assume the $errors variable is always defined and can be safely used. The $errors variable will be an instance of Illuminate\Support\MessageBag. For more information on working with this object, check out its documentation.

So, in our example, the user will be redirected to our controller's create method when validation fails, allowing us to display the error messages in the view:

 1<!-- /resources/views/post/create.blade.php -->
 2 
 3<h1>Create Post</h1>
 4 
 5@if ($errors->any())
 6    <div class="alert alert-danger">
 7        <ul>
 8            @foreach ($errors->all() as $error)
 9                <li>{{ $error }}</li>
10            @endforeach
11        </ul>
12    </div>
13@endif
14 
15<!-- Create Post Form -->
 1<!-- /resources/views/post/create.blade.php -->
 2 
 3<h1>Create Post</h1>
 4 
 5@if ($errors->any())
 6    <div class="alert alert-danger">
 7        <ul>
 8            @foreach ($errors->all() as $error)
 9                <li>{{ $error }}</li>
10            @endforeach
11        </ul>
12    </div>
13@endif
14 
15<!-- Create Post Form -->

Customizing The Error Messages

Laravel's built-in validation rules each has an error message that is located in your application's resources/lang/en/validation.php file. Within this file, you will find a translation entry for each validation rule. You are free to change or modify these messages based on the needs of your application.

In addition, you may copy this file to another translation language directory to translate the messages for your application's language. To learn more about Laravel localization, check out the complete localization documentation.

XHR Requests & Validation

In this example, we used a traditional form to send data to the application. However, many applications receive XHR requests from a JavaScript powered frontend. When using the validate method during an XHR request, Laravel will not generate a redirect response. Instead, Laravel generates a JSON response containing all of the validation errors. This JSON response will be sent with a 422 HTTP status code.

The @error Directive

You may use the @error Blade directive to quickly determine if validation error messages exist for a given attribute. Within an @error directive, you may echo the $message variable to display the error message:

1<!-- /resources/views/post/create.blade.php -->
2 
3<label for="title">Post Title</label>
4 
5<input id="title" type="text" name="title" class="@error('title') is-invalid @enderror">
6 
7@error('title')
8    <div class="alert alert-danger">{{ $message }}</div>
9@enderror
1<!-- /resources/views/post/create.blade.php -->
2 
3<label for="title">Post Title</label>
4 
5<input id="title" type="text" name="title" class="@error('title') is-invalid @enderror">
6 
7@error('title')
8    <div class="alert alert-danger">{{ $message }}</div>
9@enderror

If you are using named error bags, you may pass the name of the error bag as the second argument to the @error directive:

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

Repopulating Forms

When Laravel generates a redirect response due to a validation error, the framework will automatically flash all of the request's input to the session. This is done so that you may conveniently access the input during the next request and repopulate the form that the user attempted to submit.

To retrieve flashed input from the previous request, invoke the old method on an instance of Illuminate\Http\Request. The old method will pull the previously flashed input data from the session:

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

Laravel also provides a global old helper. If you are displaying old input within a Blade template, it is more convenient to use the old helper to repopulate the form. If no old input exists for the given field, null will be returned:

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

A Note On Optional Fields

By default, Laravel includes the TrimStrings and ConvertEmptyStringsToNull middleware in your application's global middleware stack. These middleware are listed in the stack by the App\Http\Kernel class. Because of this, you will often need to mark your "optional" request fields as nullable if you do not want the validator to consider null values as invalid. For example:

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

In this example, we are specifying that the publish_at field may be either null or a valid date representation. If the nullable modifier is not added to the rule definition, the validator would consider null an invalid date.

Form Request Validation

Creating Form Requests

For more complex validation scenarios, you may wish to create a "form request". Form requests are custom request classes that encapsulate their own validation and authorization logic. To create a form request class, you may use the make:request Artisan CLI command:

1php artisan make:request StorePostRequest
1php artisan make:request StorePostRequest

The generated form request class will be placed in the app/Http/Requests directory. If this directory does not exist, it will be created when you run the make:request command. Each form request generated by Laravel has two methods: authorize and rules.

As you might have guessed, the authorize method is responsible for determining if the currently authenticated user can perform the action represented by the request, while the rules method returns the validation rules that should apply to the request's data:

 1/**
 2 * Get the validation rules that apply to the request.
 3 *
 4 * @return array
 5 */
 6public function rules()
 7{
 8    return [
 9        'title' => 'required|unique:posts|max:255',
10        'body' => 'required',
11    ];
12}
 1/**
 2 * Get the validation rules that apply to the request.
 3 *
 4 * @return array
 5 */
 6public function rules()
 7{
 8    return [
 9        'title' => 'required|unique:posts|max:255',
10        'body' => 'required',
11    ];
12}

So, how are the validation rules evaluated? All you need to do is type-hint the request on your controller method. The incoming form request is validated before the controller method is called, meaning you do not need to clutter your controller with any validation logic:

 1/**
 2 * Store a new blog post.
 3 *
 4 * @param  \App\Http\Requests\StorePostRequest  $request
 5 * @return Illuminate\Http\Response
 6 */
 7public function store(StorePostRequest $request)
 8{
 9    // The incoming request is valid...
10 
11    // Retrieve the validated input data...
12    $validated = $request->validated();
13 
14    // Retrieve a portion of the validated input data...
15    $validated = $request->safe()->only(['name', 'email']);
16    $validated = $request->safe()->except(['name', 'email']);
17}
 1/**
 2 * Store a new blog post.
 3 *
 4 * @param  \App\Http\Requests\StorePostRequest  $request
 5 * @return Illuminate\Http\Response
 6 */
 7public function store(StorePostRequest $request)
 8{
 9    // The incoming request is valid...
10 
11    // Retrieve the validated input data...
12    $validated = $request->validated();
13 
14    // Retrieve a portion of the validated input data...
15    $validated = $request->safe()->only(['name', 'email']);
16    $validated = $request->safe()->except(['name', 'email']);
17}

If validation fails, a redirect response will be generated to send the user back to their previous location. The errors will also be flashed to the session so they are available for display. If the request was an XHR request, an HTTP response with a 422 status code will be returned to the user including a JSON representation of the validation errors.

Adding After Hooks To Form Requests

If you would like to add an "after" validation hook to a form request, you may use the withValidator method. This method receives the fully constructed validator, allowing you to call any of its methods before the validation rules are actually evaluated:

 1/**
 2 * Configure the validator instance.
 3 *
 4 * @param  \Illuminate\Validation\Validator  $validator
 5 * @return void
 6 */
 7public function withValidator($validator)
 8{
 9    $validator->after(function ($validator) {
10        if ($this->somethingElseIsInvalid()) {
11            $validator->errors()->add('field', 'Something is wrong with this field!');
12        }
13    });
14}
 1/**
 2 * Configure the validator instance.
 3 *
 4 * @param  \Illuminate\Validation\Validator  $validator
 5 * @return void
 6 */
 7public function withValidator($validator)
 8{
 9    $validator->after(function ($validator) {
10        if ($this->somethingElseIsInvalid()) {
11            $validator->errors()->add('field', 'Something is wrong with this field!');
12        }
13    });
14}

Stopping On First Validation Failure Attribute

By adding a stopOnFirstFailure property to your request class, you may inform the validator that it should stop validating all attributes once a single validation failure has occurred:

1/**
2 * Indicates if the validator should stop on the first rule failure.
3 *
4 * @var bool
5 */
6protected $stopOnFirstFailure = true;
1/**
2 * Indicates if the validator should stop on the first rule failure.
3 *
4 * @var bool
5 */
6protected $stopOnFirstFailure = true;

Customizing The Redirect Location

As previously discussed, a redirect response will be generated to send the user back to their previous location when form request validation fails. However, you are free to customize this behavior. To do so, define a $redirect property on your form request:

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

Or, if you would like to redirect users to a named route, you may define a $redirectRoute property instead:

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

Authorizing Form Requests

The form request class also contains an authorize method. Within this method, you may determine if the authenticated user actually has the authority to update a given resource. For example, you may determine if a user actually owns a blog comment they are attempting to update. Most likely, you will interact with your authorization gates and policies within this method:

 1use App\Models\Comment;
 2 
 3/**
 4 * Determine if the user is authorized to make this request.
 5 *
 6 * @return bool
 7 */
 8public function authorize()
 9{
10    $comment = Comment::find($this->route('comment'));
11 
12    return $comment && $this->user()->can('update', $comment);
13}
 1use App\Models\Comment;
 2 
 3/**
 4 * Determine if the user is authorized to make this request.
 5 *
 6 * @return bool
 7 */
 8public function authorize()
 9{
10    $comment = Comment::find($this->route('comment'));
11 
12    return $comment && $this->user()->can('update', $comment);
13}

Since all form requests extend the base Laravel request class, we may use the user method to access the currently authenticated user. Also, note the call to the route method in the example above. This method grants you access to the URI parameters defined on the route being called, such as the {comment} parameter in the example below:

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

Therefore, if your application is taking advantage of route model binding, your code may be made even more succinct by accessing the resolved model as a property of the request:

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

If the authorize method returns false, an HTTP response with a 403 status code will automatically be returned and your controller method will not execute.

If you plan to handle authorization logic for the request in another part of your application, you may simply return true from the authorize method:

1/**
2 * Determine if the user is authorized to make this request.
3 *
4 * @return bool
5 */
6public function authorize()
7{
8    return true;
9}
1/**
2 * Determine if the user is authorized to make this request.
3 *
4 * @return bool
5 */
6public function authorize()
7{
8    return true;
9}

Customizing The Error Messages

You may customize the error messages used by the form request by overriding the messages method. This method should return an array of attribute / rule pairs and their corresponding error messages:

 1/**
 2 * Get the error messages for the defined validation rules.
 3 *
 4 * @return array
 5 */
 6public function messages()
 7{
 8    return [
 9        'title.required' => 'A title is required',
10        'body.required' => 'A message is required',
11    ];
12}
 1/**
 2 * Get the error messages for the defined validation rules.
 3 *
 4 * @return array
 5 */
 6public function messages()
 7{
 8    return [
 9        'title.required' => 'A title is required',
10        'body.required' => 'A message is required',
11    ];
12}

Customizing The Validation Attributes

Many of Laravel's built-in validation rule error messages contain an :attribute placeholder. If you would like the :attribute placeholder of your validation message to be replaced with a custom attribute name, you may specify the custom names by overriding the attributes method. This method should return an array of attribute / name pairs:

 1/**
 2 * Get custom attributes for validator errors.
 3 *
 4 * @return array
 5 */
 6public function attributes()
 7{
 8    return [
 9        'email' => 'email address',
10    ];
11}
 1/**
 2 * Get custom attributes for validator errors.
 3 *
 4 * @return array
 5 */
 6public function attributes()
 7{
 8    return [
 9        'email' => 'email address',
10    ];
11}

Preparing Input For Validation

If you need to prepare or sanitize any data from the request before you apply your validation rules, you may use the prepareForValidation method:

 1use Illuminate\Support\Str;
 2 
 3/**
 4 * Prepare the data for validation.
 5 *
 6 * @return void
 7 */
 8protected function prepareForValidation()
 9{
10    $this->merge([
11        'slug' => Str::slug($this->slug),
12    ]);
13}
 1use Illuminate\Support\Str;
 2 
 3/**
 4 * Prepare the data for validation.
 5 *
 6 * @return void
 7 */
 8protected function prepareForValidation()
 9{
10    $this->merge([
11        'slug' => Str::slug($this->slug),
12    ]);
13}

Manually Creating Validators

If you do not want to use the validate method on the request, you may create a validator instance manually using the Validator facade. The make method on the facade generates a new validator instance:

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Http\Request;
 7use Illuminate\Support\Facades\Validator;
 8 
 9class PostController extends Controller
10{
11    /**
12     * Store a new blog post.
13     *
14     * @param  Request  $request
15     * @return Response
16     */
17    public function store(Request $request)
18    {
19        $validator = Validator::make($request->all(), [
20            'title' => 'required|unique:posts|max:255',
21            'body' => 'required',
22        ]);
23 
24        if ($validator->fails()) {
25            return redirect('post/create')
26                        ->withErrors($validator)
27                        ->withInput();
28        }
29 
30        // Retrieve the validated input...
31        $validated = $validator->validated();
32 
33        // Retrieve a portion of the validated input...
34        $validated = $validator->safe()->only(['name', 'email']);
35        $validated = $validator->safe()->except(['name', 'email']);
36 
37        // Store the blog post...
38    }
39}
 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use App\Http\Controllers\Controller;
 6use Illuminate\Http\Request;
 7use Illuminate\Support\Facades\Validator;
 8 
 9class PostController extends Controller
10{
11    /**
12     * Store a new blog post.
13     *
14     * @param  Request  $request
15     * @return Response
16     */
17    public function store(Request $request)
18    {
19        $validator = Validator::make($request->all(), [
20            'title' => 'required|unique:posts|max:255',
21            'body' => 'required',
22        ]);
23 
24        if ($validator->fails()) {
25            return redirect('post/create')
26                        ->withErrors($validator)
27                        ->withInput();
28        }
29 
30        // Retrieve the validated input...
31        $validated = $validator->validated();
32 
33        // Retrieve a portion of the validated input...
34        $validated = $validator->safe()->only(['name', 'email']);
35        $validated = $validator->safe()->except(['name', 'email']);
36 
37        // Store the blog post...
38    }
39}

The first argument passed to the make method is the data under validation. The second argument is an array of the validation rules that should be applied to the data.

After determining whether the request validation failed, you may use the withErrors method to flash the error messages to the session. When using this method, the $errors variable will automatically be shared with your views after redirection, allowing you to easily display them back to the user. The withErrors method accepts a validator, a MessageBag, or a PHP array.

Stopping On First Validation Failure

The stopOnFirstFailure method will inform the validator that it should stop validating all attributes once a single validation failure has occurred:

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

Automatic Redirection

If you would like to create a validator instance manually but still take advantage of the automatic redirection offered by the HTTP request's validate method, you may call the validate method on an existing validator instance. If validation fails, the user will automatically be redirected or, in the case of an XHR request, a JSON response will be returned:

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

You may use the validateWithBag method to store the error messages in a named error bag if validation fails:

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

Named Error Bags

If you have multiple forms on a single page, you may wish to name the MessageBag containing the validation errors, allowing you to retrieve the error messages for a specific form. To achieve this, pass a name as the second argument to withErrors:

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

You may then access the named MessageBag instance from the $errors variable:

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

Customizing The Error Messages

If needed, you may provide custom error messages that a validator instance should use instead of the default error messages provided by Laravel. There are several ways to specify custom messages. First, you may pass the custom messages as the third argument to the Validator::make method:

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

In this example, the :attribute placeholder will be replaced by the actual name of the field under validation. You may also utilize other placeholders in validation messages. For example:

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

Specifying A Custom Message For A Given Attribute

Sometimes you may wish to specify a custom error message only for a specific attribute. You may do so using "dot" notation. Specify the attribute's name first, followed by the rule:

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

Specifying Custom Attribute Values

Many of Laravel's built-in error messages include an :attribute placeholder that is replaced with the name of the field or attribute under validation. To customize the values used to replace these placeholders for specific fields, you may pass an array of custom attributes as the fourth argument to the Validator::make method:

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

After Validation Hook

You may also attach callbacks to be run after validation is completed. This allows you to easily perform further validation and even add more error messages to the message collection. To get started, call the after method on a validator instance:

 1$validator = Validator::make(...);
 2 
 3$validator->after(function ($validator) {
 4    if ($this->somethingElseIsInvalid()) {
 5        $validator->errors()->add(
 6            'field', 'Something is wrong with this field!'
 7        );
 8    }
 9});
10 
11if ($validator->fails()) {
12    //
13}
 1$validator = Validator::make(...);
 2 
 3$validator->after(function ($validator) {
 4    if ($this->somethingElseIsInvalid()) {
 5        $validator->errors()->add(
 6            'field', 'Something is wrong with this field!'
 7        );
 8    }
 9});
10 
11if ($validator->fails()) {
12    //
13}

Working With Validated Input

After validating incoming request data using a form request or a manually created validator instance, you may wish to retrieve the incoming request data that actually underwent validation. This can be accomplished in several ways. First, you may call the validated method on a form request or validator instance. This method returns an array of the data that was validated:

1$validated = $request->validated();
2 
3$validated = $validator->validated();
1$validated = $request->validated();
2 
3$validated = $validator->validated();

Alternatively, you may call the safe method on a form request or validator instance. This method returns an instance of Illuminate\Support\ValidatedInput. This object exposes only, except, and all methods to retrieve a subset of the validated data or the entire array of validated data:

1$validated = $request->safe()->only(['name', 'email']);
2 
3$validated = $request->safe()->except(['name', 'email']);
4 
5$validated = $request->safe()->all();
1$validated = $request->safe()->only(['name', 'email']);
2 
3$validated = $request->safe()->except(['name', 'email']);
4 
5$validated = $request->safe()->all();

In addition, the Illuminate\Support\ValidatedInput instance may be iterated over and accessed like an array:

1// Validated data may be iterated...
2foreach ($request->safe() as $key => $value) {
3    //
4}
5 
6// Validated data may be accessed as an array...
7$validated = $request->safe();
8 
9$email = $validated['email'];
1// Validated data may be iterated...
2foreach ($request->safe() as $key => $value) {
3    //
4}
5 
6// Validated data may be accessed as an array...
7$validated = $request->safe();
8 
9$email = $validated['email'];

If you would like to add additional fields to the validated data, you may call the merge method:

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

If you would like to retrieve the validated data as a collection instance, you may call the collect method:

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

Working With Error Messages

After calling the errors method on a Validator instance, you will receive an Illuminate\Support\MessageBag instance, which has a variety of convenient methods for working with error messages. The $errors variable that is automatically made available to all views is also an instance of the MessageBag class.

Retrieving The First Error Message For A Field

To retrieve the first error message for a given field, use the first method:

1$errors = $validator->errors();
2 
3echo $errors->first('email');
1$errors = $validator->errors();
2 
3echo $errors->first('email');

Retrieving All Error Messages For A Field

If you need to retrieve an array of all the messages for a given field, use the get method:

1foreach ($errors->get('email') as $message) {
2    //
3}
1foreach ($errors->get('email') as $message) {
2    //
3}

If you are validating an array form field, you may retrieve all of the messages for each of the array elements using the * character:

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

Retrieving All Error Messages For All Fields

To retrieve an array of all messages for all fields, use the all method:

1foreach ($errors->all() as $message) {
2    //
3}
1foreach ($errors->all() as $message) {
2    //
3}

Determining If Messages Exist For A Field

The has method may be used to determine if any error messages exist for a given field:

1if ($errors->has('email')) {
2    //
3}
1if ($errors->has('email')) {
2    //
3}

Specifying Custom Messages In Language Files

Laravel's built-in validation rules each has an error message that is located in your application's resources/lang/en/validation.php file. Within this file, you will find a translation entry for each validation rule. You are free to change or modify these messages based on the needs of your application.

In addition, you may copy this file to another translation language directory to translate the messages for your application's language. To learn more about Laravel localization, check out the complete localization documentation.

Custom Messages For Specific Attributes

You may customize the error messages used for specified attribute and rule combinations within your application's validation language files. To do so, add your message customizations to the custom array of your application's resources/lang/xx/validation.php language file:

1'custom' => [
2    'email' => [
3        'required' => 'We need to know your email address!',
4        'max' => 'Your email address is too long!'
5    ],
6],
1'custom' => [
2    'email' => [
3        'required' => 'We need to know your email address!',
4        'max' => 'Your email address is too long!'
5    ],
6],

Specifying Attributes In Language Files

Many of Laravel's built-in error messages include an :attribute placeholder that is replaced with the name of the field or attribute under validation. If you would like the :attribute portion of your validation message to be replaced with a custom value, you may specify the custom attribute name in the attributes array of your resources/lang/xx/validation.php language file:

1'attributes' => [
2    'email' => 'email address',
3],
1'attributes' => [
2    'email' => 'email address',
3],

Specifying Values In Language Files

Some of Laravel's built-in validation rule error messages contain a :value placeholder that is replaced with the current value of the request attribute. However, you may occasionally need the :value portion of your validation message to be replaced with a custom representation of the value. For example, consider the following rule that specifies that a credit card number is required if the payment_type has a value of cc:

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

If this validation rule fails, it will produce the following error message:

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

Instead of displaying cc as the payment type value, you may specify a more user-friendly value representation in your resources/lang/xx/validation.php language file by defining a values array:

1'values' => [
2    'payment_type' => [
3        'cc' => 'credit card'
4    ],
5],
1'values' => [
2    'payment_type' => [
3        'cc' => 'credit card'
4    ],
5],

After defining this value, the validation rule will produce the following error message:

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

Available Validation Rules

Below is a list of all available validation rules and their function:

accepted

The field under validation must be "yes", "on", 1, or true. This is useful for validating "Terms of Service" acceptance or similar fields.

accepted_if:anotherfield,value,...

The field under validation must be "yes", "on", 1, or true if another field under validation is equal to a specified value. This is useful for validating "Terms of Service" acceptance or similar fields.

active_url

The field under validation must have a valid A or AAAA record according to the dns_get_record PHP function. The hostname of the provided URL is extracted using the parse_url PHP function before being passed to dns_get_record.

after:date

The field under validation must be a value after a given date. The dates will be passed into the strtotime PHP function in order to be converted to a valid DateTime instance:

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

Instead of passing a date string to be evaluated by strtotime, you may specify another field to compare against the date:

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

after_or_equal:date

The field under validation must be a value after or equal to the given date. For more information, see the after rule.

alpha

The field under validation must be entirely alphabetic characters.

alpha_dash

The field under validation may have alpha-numeric characters, as well as dashes and underscores.

alpha_num

The field under validation must be entirely alpha-numeric characters.

array

The field under validation must be a PHP array.

When additional values are provided to the array rule, each key in the input array must be present within the list of values provided to the rule. In the following example, the admin key in the input array is invalid since it is not contained in the list of values provided to the array rule:

 1use Illuminate\Support\Facades\Validator;
 2 
 3$input = [
 4    'user' => [
 5        'name' => 'Taylor Otwell',
 6        'username' => 'taylorotwell',
 7        'admin' => true,
 8    ],
 9];
10 
11Validator::make($input, [
12    'user' => 'array:username,locale',
13]);
 1use Illuminate\Support\Facades\Validator;
 2 
 3$input = [
 4    'user' => [
 5        'name' => 'Taylor Otwell',
 6        'username' => 'taylorotwell',
 7        'admin' => true,
 8    ],
 9];
10 
11Validator::make($input, [
12    'user' => 'array:username,locale',
13]);

In general, you should always specify the array keys that are allowed to be present within your array. Otherwise, the validator's validate and validated methods will return all of the validated data, including the array and all of its keys, even if those keys were not validated by other nested array validation rules.

If you would like, you may instruct Laravel's validator to never include unvalidated array keys in the "validated" data it returns, even if you use the array rule without specifying a list of allowed keys. To accomplish this, you may call the validator's excludeUnvalidatedArrayKeys method in the boot method of your application's AppServiceProvider. After doing so, the validator will include array keys in the "validated" data it returns only when those keys were specifically validated by nested array rules:

 1use Illuminate\Support\Facades\Validator;
 2 
 3/**
 4 * Register any application services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Validator::excludeUnvalidatedArrayKeys();
11}
 1use Illuminate\Support\Facades\Validator;
 2 
 3/**
 4 * Register any application services.
 5 *
 6 * @return void
 7 */
 8public function boot()
 9{
10    Validator::excludeUnvalidatedArrayKeys();
11}

bail

Stop running validation rules for the field after the first validation failure.

While the bail rule will only stop validating a specific field when it encounters a validation failure, the stopOnFirstFailure method will inform the validator that it should stop validating all attributes once a single validation failure has occurred:

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

before:date

The field under validation must be a value preceding the given date. The dates will be passed into the PHP strtotime function in order to be converted into a valid DateTime instance. In addition, like the after rule, the name of another field under validation may be supplied as the value of date.

before_or_equal:date

The field under validation must be a value preceding or equal to the given date. The dates will be passed into the PHP strtotime function in order to be converted into a valid DateTime instance. In addition, like the after rule, the name of another field under validation may be supplied as the value of date.

between:min,max

The field under validation must have a size between the given min and max. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.

boolean

The field under validation must be able to be cast as a boolean. Accepted input are true, false, 1, 0, "1", and "0".

confirmed

The field under validation must have a matching field of {field}_confirmation. For example, if the field under validation is password, a matching password_confirmation field must be present in the input.

current_password

The field under validation must match the authenticated user's password. You may specify an authentication guard using the rule's first parameter:

1'password' => 'current_password:api'
1'password' => 'current_password:api'

date

The field under validation must be a valid, non-relative date according to the strtotime PHP function.

date_equals:date

The field under validation must be equal to the given date. The dates will be passed into the PHP strtotime function in order to be converted into a valid DateTime instance.

date_format:format

The field under validation must match the given format. You should use either date or date_format when validating a field, not both. This validation rule supports all formats supported by PHP's DateTime class.

declined

The field under validation must be "no", "off", 0, or false.

declined_if:anotherfield,value,...

The field under validation must be "no", "off", 0, or false if another field under validation is equal to a specified value.

different:field

The field under validation must have a different value than field.

digits:value

The field under validation must be numeric and must have an exact length of value.

digits_between:min,max

The field under validation must be numeric and must have a length between the given min and max.

dimensions

The file under validation must be an image meeting the dimension constraints as specified by the rule's parameters:

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

Available constraints are: min_width, max_width, min_height, max_height, width, height, ratio.

A ratio constraint should be represented as width divided by height. This can be specified either by a fraction like 3/2 or a float like 1.5:

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

Since this rule requires several arguments, you may use the Rule::dimensions method to fluently construct the rule:

1use Illuminate\Support\Facades\Validator;
2use Illuminate\Validation\Rule;
3 
4Validator::make($data, [
5    'avatar' => [
6        'required',
7        Rule::dimensions()->maxWidth(1000)->maxHeight(500)->ratio(3 / 2),
8    ],
9]);
1use Illuminate\Support\Facades\Validator;
2use Illuminate\Validation\Rule;
3 
4Validator::make($data, [
5    'avatar' => [
6        'required',
7        Rule::dimensions()->maxWidth(1000)->maxHeight(500)->ratio(3 / 2),
8    ],
9]);

distinct

When validating arrays, the field under validation must not have any duplicate values:

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

Distinct uses loose variable comparisons by default. To use strict comparisons, you may add the strict parameter to your validation rule definition:

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

You may add ignore_case to the validation rule's arguments to make the rule ignore capitalization differences:

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

email

The field under validation must be formatted as an email address. This validation rule utilizes the egulias/email-validator package for validating the email address. By default, the RFCValidation validator is applied, but you can apply other validation styles as well:

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

The example above will apply the RFCValidation and DNSCheckValidation validations. Here's a full list of validation styles you can apply:

The filter validator, which uses PHP's filter_var function, ships with Laravel and was Laravel's default email validation behavior prior to Laravel version 5.8.

ends_with:foo,bar,...

The field under validation must end with one of the given values.

enum

The Enum rule is a class based rule that validates whether the field under validation contains a valid enum value. The Enum rule accepts the name of the enum as its only constructor argument:

1use App\Enums\ServerStatus;
2use Illuminate\Validation\Rules\Enum;
3 
4$request->validate([
5    'status' => [new Enum(ServerStatus::class)],
6]);
1use App\Enums\ServerStatus;
2use Illuminate\Validation\Rules\Enum;
3 
4$request->validate([
5    'status' => [new Enum(ServerStatus::class)],
6]);

exclude

The field under validation will be excluded from the request data returned by the validate and validated methods.

exclude_if:anotherfield,value

The field under validation will be excluded from the request data returned by the validate and validated methods if the anotherfield field is equal to value.

exclude_unless:anotherfield,value

The field under validation will be excluded from the request data returned by the validate and validated methods unless anotherfield's field is equal to value. If value is null (exclude_unless:name,null), the field under validation will be excluded unless the comparison field is null or the comparison field is missing from the request data.

exclude_without:anotherfield

The field under validation will be excluded from the request data returned by the validate and validated methods if the anotherfield field is not present.

exists:table,column

The field under validation must exist in a given database table.

Basic Usage Of Exists Rule

1'state' => 'exists:states'
1'state' => 'exists:states'

If the column option is not specified, the field name will be used. So, in this case, the rule will validate that the states database table contains a record with a state column value matching the request's state attribute value.

Specifying A Custom Column Name

You may explicitly specify the database column name that should be used by the validation rule by placing it after the database table name:

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

Occasionally, you may need to specify a specific database connection to be used for the exists query. You can accomplish this by prepending the connection name to the table name:

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

Instead of specifying the table name directly, you may specify the Eloquent model which should be used to determine the table name:

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

If you would like to customize the query executed by the validation rule, you may use the Rule class to fluently define the rule. In this example, we'll also specify the validation rules as an array instead of using the | character to delimit them:

 1use Illuminate\Support\Facades\Validator;
 2use Illuminate\Validation\Rule;
 3 
 4Validator::make($data, [
 5    'email' => [
 6        'required',
 7        Rule::exists('staff')->where(function ($query) {
 8            return $query->where('account_id', 1);
 9        }),
10    ],
11]);
 1use Illuminate\Support\Facades\Validator;
 2use Illuminate\Validation\Rule;
 3 
 4Validator::make($data, [
 5    'email' => [
 6        'required',
 7        Rule::exists('staff')->where(function ($query) {
 8            return $query->where('account_id', 1);
 9        }),
10    ],
11]);

file

The field under validation must be a successfully uploaded file.

filled

The field under validation must not be empty when it is present.

gt:field

The field under validation must be greater than the given field. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size rule.

gte:field

The field under validation must be greater than or equal to the given field. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size rule.

image

The file under validation must be an image (jpg, jpeg, png, bmp, gif, svg, or webp).

in:foo,bar,...

The field under validation must be included in the given list of values. Since this rule often requires you to implode an array, the Rule::in method may be used to fluently construct the rule:

1use Illuminate\Support\Facades\Validator;
2use Illuminate\Validation\Rule;
3 
4Validator::make($data, [
5    'zones' => [
6        'required',
7        Rule::in(['first-zone', 'second-zone']),
8    ],
9]);
1use Illuminate\Support\Facades\Validator;
2use Illuminate\Validation\Rule;
3 
4Validator::make($data, [
5    'zones' => [
6        'required',
7        Rule::in(['first-zone', 'second-zone']),
8    ],
9]);

When the in rule is combined with the array rule, each value in the input array must be present within the list of values provided to the in rule. In the following example, the LAS airport code in the input array is invalid since it is not contained in the list of airports provided to the in rule:

 1use Illuminate\Support\Facades\Validator;
 2use Illuminate\Validation\Rule;
 3 
 4$input = [
 5    'airports' => ['NYC', 'LAS'],
 6];
 7 
 8Validator::make($input, [
 9    'airports' => [
10        'required',
11        'array',
12        Rule::in(['NYC', 'LIT']),
13    ],
14]);
 1use Illuminate\Support\Facades\Validator;
 2use Illuminate\Validation\Rule;
 3 
 4$input = [
 5    'airports' => ['NYC', 'LAS'],
 6];
 7 
 8Validator::make($input, [
 9    'airports' => [
10        'required',
11        'array',
12        Rule::in(['NYC', 'LIT']),
13    ],
14]);

in_array:anotherfield.*

The field under validation must exist in anotherfield's values.

integer

The field under validation must be an integer.

ip

The field under validation must be an IP address.

ipv4

The field under validation must be an IPv4 address.

ipv6

The field under validation must be an IPv6 address.

mac_address

The field under validation must be a MAC address.

json

The field under validation must be a valid JSON string.

lt:field

The field under validation must be less than the given field. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size rule.

lte:field

The field under validation must be less than or equal to the given field. The two fields must be of the same type. Strings, numerics, arrays, and files are evaluated using the same conventions as the size rule.

max:value

The field under validation must be less than or equal to a maximum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.

mimetypes:text/plain,...

The file under validation must match one of the given MIME types:

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

To determine the MIME type of the uploaded file, the file's contents will be read and the framework will attempt to guess the MIME type, which may be different from the client's provided MIME type.

mimes:foo,bar,...

The file under validation must have a MIME type corresponding to one of the listed extensions.

Basic Usage Of MIME Rule

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

Even though you only need to specify the extensions, this rule actually validates the MIME type of the file by reading the file's contents and guessing its MIME type. A full listing of MIME types and their corresponding extensions may be found at the following location:

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

min:value

The field under validation must have a minimum value. Strings, numerics, arrays, and files are evaluated in the same fashion as the size rule.

multiple_of:value

The field under validation must be a multiple of value.

not_in:foo,bar,...

The field under validation must not be included in the given list of values. The Rule::notIn method may be used to fluently construct the rule:

1use Illuminate\Validation\Rule;
2 
3Validator::make($data, [
4    'toppings' => [
5        'required',
6        Rule::notIn(['sprinkles', 'cherries']),
7    ],
8]);
1use Illuminate\Validation\Rule;
2 
3Validator::make($data, [
4    'toppings' => [
5        'required',
6        Rule::notIn(['sprinkles', 'cherries']),
7    ],
8]);

not_regex:pattern

The field under validation must not match the given regular expression.

Internally, this rule uses the PHP preg_match function. The pattern specified should obey the same formatting required by preg_match and thus also include valid delimiters. For example: 'email' => 'not_regex:/^.+$/i'.

nullable

The field under validation may be null.

numeric

The field under validation must be numeric.

password

The field under validation must match the authenticated user's password.

present

The field under validation must be present in the input data but can be empty.

prohibited

The field under validation must be empty or not present.

prohibited_if:anotherfield,value,...

The field under validation must be empty or not present if the anotherfield field is equal to any value.

prohibited_unless:anotherfield,value,...

The field under validation must be empty or not present unless the anotherfield field is equal to any value.

prohibits:anotherfield,...

If the field under validation is present, no fields in anotherfield can be present, even if empty.

regex:pattern

The field under validation must match the given regular expression.

Internally, this rule uses the PHP preg_match function. The pattern specified should obey the same formatting required by preg_match and thus also include valid delimiters. For example: 'email' => 'regex:/^.+@.+$/i'.

required

The field under validation must be present in the input data and not empty. A field is considered "empty" if one of the following conditions are true:

required_if:anotherfield,value,...

The field under validation must be present and not empty if the anotherfield field is equal to any value.

If you would like to construct a more complex condition for the required_if rule, you may use the Rule::requiredIf method. This method accepts a boolean or a closure. When passed a closure, the closure should return true or false to indicate if the field under validation is required:

 1use Illuminate\Support\Facades\Validator;
 2use Illuminate\Validation\Rule;
 3 
 4Validator::make($request->all(), [
 5    'role_id' => Rule::requiredIf($request->user()->is_admin),
 6]);
 7 
 8Validator::make($request->all(), [
 9    'role_id' => Rule::requiredIf(function () use ($request) {
10        return $request->user()->is_admin;
11    }),
12]);
 1use Illuminate\Support\Facades\Validator;
 2use Illuminate\Validation\Rule;
 3 
 4Validator::make($request->all(), [
 5    'role_id' => Rule::requiredIf($request->user()->is_admin),
 6]);
 7 
 8Validator::make($request->all(), [
 9    'role_id' => Rule::requiredIf(function () use ($request) {
10        return $request->user()->is_admin;
11    }),
12]);

required_unless:anotherfield,value,...

The field under validation must be present and not empty unless the anotherfield field is equal to any value. This also means anotherfield must be present in the request data unless value is null. If value is null (required_unless:name,null), the field under validation will be required unless the comparison field is null or the comparison field is missing from the request data.

required_with:foo,bar,...

The field under validation must be present and not empty only if any of the other specified fields are present and not empty.

required_with_all:foo,bar,...

The field under validation must be present and not empty only if all of the other specified fields are present and not empty.

required_without:foo,bar,...

The field under validation must be present and not empty only when any of the other specified fields are empty or not present.

required_without_all:foo,bar,...

The field under validation must be present and not empty only when all of the other specified fields are empty or not present.

same:field

The given field must match the field under validation.

size:value

The field under validation must have a size matching the given value. For string data, value corresponds to the number of characters. For numeric data, value corresponds to a given integer value (the attribute must also have the numeric or integer rule). For an array, size corresponds to the count of the array. For files, size corresponds to the file size in kilobytes. Let's look at some examples:

 1// Validate that a string is exactly 12 characters long...
 2'title' => 'size:12';
 3 
 4// Validate that a provided integer equals 10...
 5'seats' => 'integer|size:10';
 6 
 7// Validate that an array has exactly 5 elements...
 8'tags' => 'array|size:5';
 9 
10// Validate that an uploaded file is exactly 512 kilobytes...
11'image' => 'file|size:512';
 1// Validate that a string is exactly 12 characters long...
 2'title' => 'size:12';
 3 
 4// Validate that a provided integer equals 10...
 5'seats' => 'integer|size:10';
 6 
 7// Validate that an array has exactly 5 elements...
 8'tags' => 'array|size:5';
 9 
10// Validate that an uploaded file is exactly 512 kilobytes...
11'image' => 'file|size:512';

starts_with:foo,bar,...

The field under validation must start with one of the given values.

string

The field under validation must be a string. If you would like to allow the field to also be null, you should assign the nullable rule to the field.

timezone

The field under validation must be a valid timezone identifier according to the timezone_identifiers_list PHP function.

unique:table,column

The field under validation must not exist within the given database table.

Specifying A Custom Table / Column Name:

Instead of specifying the table name directly, you may specify the Eloquent model which should be used to determine the table name:

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

The column option may be used to specify the field's corresponding database column. If the column option is not specified, the name of the field under validation will be used.

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

Specifying A Custom Database Connection

Occasionally, you may need to set a custom connection for database queries made by the Validator. To accomplish this, you may prepend the connection name to the table name:

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

Forcing A Unique Rule To Ignore A Given ID:

Sometimes, you may wish to ignore a given ID during unique validation. For example, consider an "update profile" screen that includes the user's name, email address, and location. You will probably want to verify that the email address is unique. However, if the user only changes the name field and not the email field, you do not want a validation error to be thrown because the user is already the owner of the email address in question.

To instruct the validator to ignore the user's ID, we'll use the Rule class to fluently define the rule. In this example, we'll also specify the validation rules as an array instead of using the | character to delimit the rules:

1use Illuminate\Support\Facades\Validator;
2use Illuminate\Validation\Rule;
3 
4Validator::make($data, [
5    'email' => [
6        'required',
7        Rule::unique('users')->ignore($user->id),
8    ],
9]);
1use Illuminate\Support\Facades\Validator;
2use Illuminate\Validation\Rule;
3 
4Validator::make($data, [
5    'email' => [
6        'required',
7        Rule::unique('users')->ignore($user->id),
8    ],
9]);

Instead of passing the model key's value to the ignore method, you may also pass the entire model instance. Laravel will automatically extract the key from the model:

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

If your table uses a primary key column name other than id, you may specify the name of the column when calling the ignore method:

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

By default, the unique rule will check the uniqueness of the column matching the name of the attribute being validated. However, you may pass a different column name as the second argument to the unique method:

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

Adding Additional Where Clauses:

You may specify additional query conditions by customizing the query using the where method. For example, let's add a query condition that scopes the query to only search records that have an account_id column value of 1:

1'email' => Rule::unique('users')->where(function ($query) {
2    return $query->where('account_id', 1);
3})
1'email' => Rule::unique('users')->where(function ($query) {
2    return $query->where('account_id', 1);
3})

url

The field under validation must be a valid URL.

uuid

The field under validation must be a valid RFC 4122 (version 1, 3, 4, or 5) universally unique identifier (UUID).

Conditionally Adding Rules

Skipping Validation When Fields Have Certain Values

You may occasionally wish to not validate a given field if another field has a given value. You may accomplish this using the exclude_if validation rule. In this example, the appointment_date and doctor_name fields will not be validated if the has_appointment field has a value of false:

1use Illuminate\Support\Facades\Validator;
2 
3$validator = Validator::make($data, [
4    'has_appointment' => 'required|boolean',
5    'appointment_date' => 'exclude_if:has_appointment,false|required|date',
6    'doctor_name' => 'exclude_if:has_appointment,false|required|string',
7]);
1use Illuminate\Support\Facades\Validator;
2 
3$validator = Validator::make($data, [
4    'has_appointment' => 'required|boolean',
5    'appointment_date' => 'exclude_if:has_appointment,false|required|date',
6    'doctor_name' => 'exclude_if:has_appointment,false|required|string',
7]);

Alternatively, you may use the exclude_unless rule to not validate a given field unless another field has a given value:

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

Validating When Present

In some situations, you may wish to run validation checks against a field only if that field is present in the data being validated. To quickly accomplish this, add the sometimes rule to your rule list:

1$v = Validator::make($data, [
2    'email' => 'sometimes|required|email',
3]);
1$v = Validator::make($data, [
2    'email' => 'sometimes|required|email',
3]);

In the example above, the email field will only be validated if it is present in the $data array.

Complex Conditional Validation

Sometimes you may wish to add validation rules based on more complex conditional logic. For example, you may wish to require a given field only if another field has a greater value than 100. Or, you may need two fields to have a given value only when another field is present. Adding these validation rules doesn't have to be a pain. First, create a Validator instance with your static rules that never change:

1use Illuminate\Support\Facades\Validator;
2 
3$validator = Validator::make($request->all(), [
4    'email' => 'required|email',
5    'games' => 'required|numeric',
6]);
1use Illuminate\Support\Facades\Validator;
2 
3$validator = Validator::make($request->all(), [
4    'email' => 'required|email',
5    'games' => 'required|numeric',
6]);

Let's assume our web application is for game collectors. If a game collector registers with our application and they own more than 100 games, we want them to explain why they own so many games. For example, perhaps they run a game resale shop, or maybe they just enjoy collecting games. To conditionally add this requirement, we can use the sometimes method on the Validator instance.

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

The first argument passed to the sometimes method is the name of the field we are conditionally validating. The second argument is a list of the rules we want to add. If the closure passed as the third argument returns true, the rules will be added. This method makes it a breeze to build complex conditional validations. You may even add conditional validations for several fields at once:

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

Complex Conditional Array Validation

Sometimes you may want to validate a field based on another field in the same nested array whose index you do not know. In these situations, you may allow your closure to receive a second argument which will be the current individual item in the array being validated:

 1$input = [
 2    'channels' => [
 3        [
 4            'type' => 'email',
 5            'address' => '[email protected]',
 6        ],
 7        [
 8            'type' => 'url',
 9            'address' => 'https://example.com',
10        ],
11    ],
12];
13 
14$validator->sometimes('channels.*.address', 'email', function ($input, $item) {
15    return $item->type === 'email';
16});
17 
18$validator->sometimes('channels.*.address', 'url', function ($input, $item) {
19    return $item->type !== 'email';
20});
 1$input = [
 2    'channels' => [
 3        [
 4            'type' => 'email',
 5            'address' => '[email protected]',
 6        ],
 7        [
 8            'type' => 'url',
 9            'address' => 'https://example.com',
10        ],
11    ],
12];
13 
14$validator->sometimes('channels.*.address', 'email', function ($input, $item) {
15    return $item->type === 'email';
16});
17 
18$validator->sometimes('channels.*.address', 'url', function ($input, $item) {
19    return $item->type !== 'email';
20});