Validation

The validations allows you to add validation to a certain field. It will print an error message regarding on the validation you set. For more information you can read in Customizer APIs.

Example a text field added required validation, the error message will print if the text field is empty.

How to add validation?

Its easy to add a validation all you need is to add validations and supply it with validations.

Yano::field( 'text', [
   'id'          => 'firstnamedb1',
   'label'       => 'Enter Your Firstname',
   'description' => 'Some description',
   'priority'    => 1,
   'validations' => [ 'required' ]
]);

Example 2: multiple validations, you can add validations as many as you can.

/**
 * This example we will going to use Yano built in validations
 * required - print error message if the field is empty
 * is_integer - print error message if the field value is not integer
 * less_than[18] - print error message if the field value is greater than or equal to "parameter" 18
 */
Yano::field( 'text', [
   'id'          => 'agedb1',
   'label'       => 'Enter Age',
   'description' => 'Some description',
   'priority'    => 1,
   'validations' => [ 'required', 'is_integer', 'less_than[18]' ]
]);

You can also create your own custom function for validations. Note the custom function name must end with _yano_validation example is_number_yano_validation.

/**
 * In this example we will going to print error message if
 * the field value is equal to "John"
 */
Yano::field( 'text', [
   'id'          => 'name',
   'label'       => 'Enter Your Name',
   'description' => 'Some description',
   'priority'    => 1,
   'validations' => [ 'required', 'is_valid_name_yano_validation' ]
]);


/**
 * Note dont for get to add "_yano_validation" in the end custom function name.
 * @param object      $validity        holds your custom error message
 * @param any         $value           the value of the field
 * @return $validity  error message
 */
function is_valid_name_yano_validation( $validity, $value ) {
   if( $value == 'John' ) {
      // printing error message
      $validity->add( 'error', 'John is invalid name.' );
   }
   // dont for get to return $validity
   return $validity;
}

Output:

Here are the list of available Yano validations.

The following are the list of all native validations that are available to use.