Validation

Overview

While configuring a blueprint or fieldset field, switch to the Validation tab where you can choose from any built in Laravel rule.

Add validation rules (with a shortcut for requiring)

In this screenshot, you can see that the field has an alpha_dash and min:4 rule which means you can only type letters and dashes, like a slug, and that it
must be at least 4 characters. You have plenty of options to be creative and confident that your data will be entered the way you need it to be.

Here's a peek at how that YAML is structured.

-
  handle: your_field
  field:
    type: text
    validate:
      - alpha_dash
      - 'min:4'

Required Fields

Being the most common type of validation rule, we give you a shortcut for that. Simply toggle it on, or add required: true to the YAML.

Validating Nestable Fields

Statamic's Grid, Replicator, and Bard fields can all contain sub-fields.

You can add validation to those sub-fields as you would with any top level fields.

However, if you want to use validation rules that target other fields, and the target field is in the same context (e.g. in the same Grid row, or same Replicator set), you may use the {this} placeholder. The path to the nested field will be expanded by Statamic for you.

-
  handle: variations
  field:
    type: grid
    fields:
      -
        handle: purchasable
        type: toggle
      -
        handle: price
        type: integer
        validate: 'required_with:{this}.purchasable'

This would make sure that the price field is only required if the purchasable toggle is true within that same set. Without {this}, it would be checking for a purchasable field at the top level of your form.

fields:
  -
    handle: purchasable
    type: toggle
  -
    handle: price
    type: integer
    if:
      purchasable: true
    validate:
      - sometimes
      - required

Available Rules

All Laravel Rules

You may use any validation rule provided by Laravel. You can view the complete list on their documentation. You may also use custom rules.

Unique Entry Value

-
  handle: highlander
  field:
    type: text
    validate: 'new \Statamic\Rules\UniqueEntryValue({collection}, {id}, {site})'

This works like Laravel's unique validation rule, but for Statamic entries. The rule should be used verbatim as shown above. Statamic will replace the collection, id, and site behind the scenes.

You can then customize the error message right in your resources/lang/{lang}/validation.php file, like so

'custom' => [
    'highlander' => [
        'unique_entry_value' => 'There can be only one!',
    ]
],

Unique Term Value

-
  handle: foo
  field:
    type: text
    validate: 'new \Statamic\Rules\UniqueTermValue({taxonomy}, {id}, {site})'

This works like the UniqueEntryValue rule, but for taxonomy terms.

Unique User Value

-
  handle: login
  field:
    type: text
    validate: 'new \Statamic\Rules\UniqueUserValue({id})'

This works like the UniqueEntryValue rule, but for users.

Custom Rules

You may use custom validation rules via Laravel's Rule objects.
Documentation on those are here.

To references those from your field, you can add them to your validation array as if you were writing PHP:

If you're writing directly into the YAML, make sure to escape any quotes:

validate:
  - required
  - string
  - new App\Rules\Uppercase
  - 'new App\Rules\AnotherRule(''with argument'')'

Validating Programmatically

You may validate programmatically via the blueprint, if you need to do so within custom code.

$values = $request->all();
 
$valid = $blueprint->fields()->addValues($values)->validate();
 
$entry->data($valid)->save();

The validate method would throw a ValidationException if invalid and return the appropriate response.