Validation
Meta Box has a built-in validation module for all fields. You can use validation to make a field required, check password length, check phone number format, etc. The validation is done on the client side.
There are 2 ways of doing validation: basic validation with input attributes and advanced validation with jQuery validation plugin. You can choose which one fits your needs.
Basic validation
Meta Box supports custom attributes for all input fields. You can use these attributes to validate the values of fields.
This type of validation uses browser validation, thus the UI and the error message depend on the browser (like language).
When editing a field, switch to the Advanced tab, and scroll down to the Custom HTML5 attributes. Then click Add New button to add a new rule.
In the Key input box, you can select any rule from the dropdown (if you don't see the dropdown, press the down arrow button), or enter the attribute name manually. And then enter the desired value in the Value input box.
This instruction uses Meta Box Builder extension, which is a premium extension and is already bundled in Meta Box AIO and MB Core. If you're not a premium user, please purchase a license to use it. However, you can do this with code. See below for more information.
These are the available attributes that you can use for validation:
| Attribute | Description |
|---|---|
max | Maximum value |
maxlength | Maximum number of characters |
min | Minimum value |
minlength | Minimum number of characters |
pattern | Match a regular expression |
required | Required |
step | Match the step increment. Enter any to accept any step. |
type | Mostly used as url or email to validate value as a valid URL or email |
If you prefer to use code to create fields, add pairs of 'key' => 'value' rules for the field settings array:
[
'type' => 'text',
'id' => 'phone',
'name' => 'Phone number',
'required' => true, // Make the field required.
'pattern' => '[0-9]{9}', // Must have 9 digits
]
Advanced validation
For more advanced validation, including new rules and custom error messages, you might want to use the validation module, powered by the popular jQuery validation plugin. It comes bundled with a useful set of validation methods and an API to write your own methods. All methods come with default error messages in English and translations into 37 other languages.
To define validation rules, switch to the Advanced tab, and scroll down to the Validation. Then click Add New button to add a new rule.
For each rule, the list of types is available as a dropdown, so you can select it. Depending on the rule type, you can enter a value and/or custom error message.
These are available validation rules that you can use:
| Name | Description |
|---|---|
required | Makes the element required |
minlength | Makes the element require a given minimum length |
maxlength | Makes the element require a given maxmimum length |
rangelength | Makes the element require a given value range. Array. |
min | Makes the element require a given minimum |
max | Makes the element require a given maximum |
range | Makes the element require a given value range. Array. |
email | Makes the element require a valid email |
url | Makes the element require a valid URL |
date | Makes the element require a date |
dateISO | Makes the element require an ISO date |
number | Makes the element require a decimal number |
digits | Makes the element require digits only |
creditcard | Makes the element require a credit card number |
equalTo | Requires the element to be the same as another one. Value must be the ID of another field. |
extension | Makes the element require certain file extensions. For file, image fields only. |
accept | Makes a file upload accept only specified mime-types. For file, image fields only. |
phoneUS | Validate for valid US phone number |
remote | Requests a resource to check the element for validity. Value can be the URL of the resource to request for server-side validation (string) or options to fully customize the request, see jQuery.ajax. The server-side resource is called via jQuery.ajax and gets a key/value pair corresponding to the name of the validated element and its value as a GET parameter. The response is evaluated as JSON and must be true for valid elements, and can be any false, undefined or null for invalid elements, using the default message; or a string, eg. "That name is already taken, try peter123 instead" to display as the error message. |
If you prefer code, you need to add a key validation to the field group settings. This key has a parameter rules for validation rules and messages for error messages.
add_filter( 'rwmb_meta_boxes', function ( $meta_boxes ) {
$meta_boxes[] = [
'title' => 'Personal info',
'post_types' => 'team_member',
'fields' => [
[
'name' => 'Email',
'id' => 'email',
'type' => 'text',
],
[
'name' => 'Address',
'id' => 'address',
'type' => 'text',
],
],
'validation' => [
'rules' => [
'email' => [
'required' => true,
'minlength' => 7,
],
// Rules for other fields
],
'messages' => [
'email' => [
'required' => 'Email is required',
'minlength' => 'Email must be at least 7 characters',
],
// Error messages for other fields
],
],
];
return $meta_boxes;
} );
The jQuery validation library actually uses the input name, not the input ID. In most cases, they are the same. But for some cases where a field has multiple inputs like a checkbox list, then the checkboxes don't have IDs.
In this case, you need to use input name for the rules. For example, if you use a taxonomy field displayed as a checkbox list, you should set validation rules as follows:
'validation' => [
'rules' => [
'my_taxonomy[]' => [
'required' => true,
],
],
'messages' => [
'my_taxonomy[]' => [
'required' => 'You must select a tag to proceed',
],
],
],
For the field types "File" and "Image", the input name has the format _file_fieldID[], you should set validation rules as follows:
'fields' => [
[
'name' => 'Uploaded Files',
'id' => 'my_files',
'type' => 'file',
],
],
'validation' => [
'rules' => [
'_file_my_files[]' => [
'extension' => 'pdf',
],
],
'messages' => [
'_file_my_files[]' => [
'extension' => 'file extension not allowed',
],
],
],
Remote validation
Remote validation is supported by the jQuery validation library, which is used by Meta Box. Using remote validation helps you use server data (such as from post or a settings) and return dynamic error messages.
To validate fields remotely with PHP, use the remote parameter for the validation rule array as follows:
'validation' => [
'rules' => [
'field_id1' => [
'remote' => admin_url( 'admin-ajax.php?action=my_action1' ),
],
],
'messages' => [
'field_id1' => [
'remote' => 'Value is not invalid.',
],
],
],
The validation performs via an ajax request with action my_action1. In your theme's functions.php file or your plugin, you need to create a callback to handle this ajax request that outputs:
- "true" if the value is valid
- "false" if the value is not valid. In this case, the error message is set in the
messagesarray as above - A custom string (not "false") if the value is not valid and you want to return it as a custom error message
add_action( 'wp_ajax_my_action1', function () {
// Get the field value via the global variable $_GET
if ( $_GET['field_id1'] === 'something' ) {
echo 'true'; // Valid
} else {
echo 'false'; // Invalid
// or
// echo 'This value is invalid, please try again.'; // Custom error message
}
die;
} );